feat: sync publication-safe source from circle-mcp-server; fix repo refs - #2
Open
iamnortey wants to merge 1 commit into
Open
feat: sync publication-safe source from circle-mcp-server; fix repo refs#2iamnortey wants to merge 1 commit into
iamnortey wants to merge 1 commit into
Conversation
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
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 toolstest/: 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)What this PR updates (repository reference fixes)
All public-facing references from
circle-mcp-server(private) tocircle-mcp(this repo):package.jsonrepository.url,homepage,bugs.urlmanifest.jsonrepository.url,supportREADME.mdCONTRIBUTING.mdSECURITY.mddocs/self-serve/CLAUDE_CODE_INSTALL.md,CLAUDE_DESKTOP_INSTALL.md../../app/...paths replaced with../tools.mddocs/distribution/REMOTE_DISTRIBUTION_QUICKSTART.md,SMITHERY_PUBLISHING_PACKAGE.mddocs/product/CLIENT_QUICKSTART.md../../app/...paths replaced with proper relative linksrc/http.ts,src/smithery.ts,smithery.yaml.gitignoreWhat this PR does NOT change
circle-mcp-server-production.up.railway.app) — these are real deployed endpoints. Renaming the Railway deployment is a separate, Railway-side operation.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— passesnpm test— passes (smoke tests)If any of these fail post-merge, the most likely cause is a missing file. Easy to add in a follow-up.