Skip to content

feat: sync publication-safe source from circle-mcp-server; fix repo refs - #2

Open
iamnortey wants to merge 1 commit into
mainfrom
feat/sync-source-from-server
Open

feat: sync publication-safe source from circle-mcp-server; fix repo refs#2
iamnortey wants to merge 1 commit into
mainfrom
feat/sync-source-from-server

Conversation

@iamnortey

Copy link
Copy Markdown
Owner

Summary

Adds the v0.3.1 source, tests, and supporting configuration to make this repository a working, cloneable, buildable installation. Resolves the broken Quick Start clone URL — the README previously told visitors to clone the private circle-mcp-server, returning a 404.

This is PR 2 of 2 for the circle-mcp cleanup. PR 1 (#1, merged) removed accidentally-published internal docs. This PR adds the publication-ready source so the public repo becomes self-sufficient.

What this PR adds (synced from circle-mcp-server)

  • src/ (entire tree): index.ts, http.ts, server.ts, smithery.ts, version.ts, clients/, config/, lib/, schemas/, tools/, types/ — 24 TypeScript source files implementing all 16 MCP tools
  • test/: smoke.ts, smoke-http.ts, smoke-live.ts, live-v020.ts, prove-write-endpoints.ts (the prove-write-results.json was excluded — it contains real community URLs from Isaac's test community)
  • Config: package.json, package-lock.json, tsconfig.json, manifest.json, smithery.yaml, smithery-config-schema.json, railway.json, .env.example, .mcpbignore
  • CI: .github/workflows/ci.yml (Node 18/20/22 matrix; typecheck + build + smoke tests)
  • Docs: CHANGELOG.md, SMITHERY_READINESS.md

What this PR updates (repository reference fixes)

All public-facing references from circle-mcp-server (private) to circle-mcp (this repo):

File Change
package.json repository.url, homepage, bugs.url
manifest.json repository.url, support
README.md Quick Start clone URL
CONTRIBUTING.md Rewritten to direct all contributions to this repo (now the canonical implementation)
SECURITY.md Scope expanded to cover source code; vulnerability reporting points to this repo's Security Advisories
docs/self-serve/CLAUDE_CODE_INSTALL.md, CLAUDE_DESKTOP_INSTALL.md Clone URLs, paths, issue links; broken ../../app/... paths replaced with ../tools.md
docs/distribution/REMOTE_DISTRIBUTION_QUICKSTART.md, SMITHERY_PUBLISHING_PACKAGE.md Clone URLs, issue links
docs/product/CLIENT_QUICKSTART.md All clone URLs, paths, issue links; broken ../../app/... paths replaced with proper relative link
src/http.ts, src/smithery.ts, smithery.yaml Cosmetic comment headers
.gitignore Merged server's more comprehensive ignore patterns with the public repo's existing entries

What this PR does NOT change

  • Live Railway deployment URLs (circle-mcp-server-production.up.railway.app) — these are real deployed endpoints. Renaming the Railway deployment is a separate, Railway-side operation.
  • README.md polished content (only the clone URL changed; the marketing/usage copy is preserved)
  • ARCHITECTURE.md, LICENSE, docs/roadmap.md, docs/tools.md, .github/FUNDING.yml — all preserved from the previous public state

Test plan

After merge, the following should work end-to-end:

  • git clone https://github.com/iamnortey/circle-mcp.git && cd circle-mcp && npm install && npm run build — produces dist/
  • npm run typecheck — passes
  • npm test — passes (smoke tests)
  • README Quick Start works against the new clone URL
  • CI workflow runs on the next PR

If any of these fail post-merge, the most likely cause is a missing file. Easy to add in a follow-up.

Adds the v0.3.1 source code, tests, and supporting configuration to make this repo a working, cloneable, buildable installation. Resolves the broken Quick Start clone URL (the README previously told visitors to clone the private circle-mcp-server, returning a 404).

Per the GITHUB_FACELIFT planning, this is the second of two PRs cleaning up circle-mcp. PR 1 removed accidentally-published internal docs; this PR adds the publication-ready source so the public repo becomes self-sufficient.

## Source files added (all from circle-mcp-server v0.3.1)

- src/ (entire tree): index.ts, http.ts, server.ts, smithery.ts, version.ts, clients/, config/, lib/, schemas/, tools/, types/
- test/: smoke.ts, smoke-http.ts, smoke-live.ts, live-v020.ts, prove-write-endpoints.ts
- Config: package.json, package-lock.json, tsconfig.json, manifest.json, smithery.yaml, smithery-config-schema.json, railway.json, .env.example, .mcpbignore
- CI: .github/workflows/ci.yml
- Docs: CHANGELOG.md, SMITHERY_READINESS.md

## Excluded from the sync

- test/prove-write-results.json (contains real community URLs and post IDs from Isaac's test community)
- docs/evidence/ and docs/reports/ (internal CI/release evidence)

## Repository reference updates

All public-facing references to circle-mcp-server (the private repo) are updated to circle-mcp:

- package.json: repository.url, homepage, bugs.url
- manifest.json: repository.url, support
- README.md: Quick Start clone URL
- CONTRIBUTING.md: rewritten to direct contributions to this repo (now the canonical implementation)
- SECURITY.md: scope updated; vulnerability reporting points to this repo
- docs/self-serve/CLAUDE_CODE_INSTALL.md, CLAUDE_DESKTOP_INSTALL.md: clone URLs, paths, issue links
- docs/distribution/REMOTE_DISTRIBUTION_QUICKSTART.md: clone URL, issue links
- docs/distribution/SMITHERY_PUBLISHING_PACKAGE.md: clone references
- docs/product/CLIENT_QUICKSTART.md: all clone URLs, paths, issue links
- src/http.ts, src/smithery.ts, smithery.yaml: comment headers
- Broken `../../app/circle-mcp-server/README.md` paths replaced with proper relative links to tools.md

## Preserved live deployment URLs (not changed)

The Railway production endpoint at https://circle-mcp-server-production.up.railway.app is the real live deployment. Renaming it is a Railway-side operation, separate from this GitHub-side rename. URLs preserved in: SMITHERY_READINESS.md, SMITHERY_PUBLISHING_PACKAGE.md, REMOTE_DISTRIBUTION_QUICKSTART.md.

## Preserved from previous public state

- README.md (the polished public version, with only the Quick Start clone URL updated)
- ARCHITECTURE.md, LICENSE
- docs/README.md (post-PR-1 cleanup version)
- docs/roadmap.md, docs/tools.md, docs/self-serve/*, docs/product/CLIENT_QUICKSTART.md, docs/product/PROMPT_STARTER_PACK.md, docs/distribution/*
- .github/FUNDING.yml

## .gitignore update

Merged the server's more comprehensive .gitignore (adds IDE files, Smithery build artifacts, .env protection with !.env.example exception) with the public repo's existing entries (app/, artifacts/samples/).

## Test plan

- [ ] After merge: clone the repo from main, run npm install && npm run build, verify dist/ is produced
- [ ] After merge: run npm run typecheck and npm test, verify both pass
- [ ] After merge: visit the rendered README, confirm Quick Start now works against the public URL
@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5116ad10-458a-4cd6-baf4-4e0d803d888b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant