{"id":28426011,"url":"https://github.com/pipe-cd/docs-mcp-server","last_synced_at":"2025-06-28T02:31:19.236Z","repository":{"id":296800709,"uuid":"986905290","full_name":"pipe-cd/docs-mcp-server","owner":"pipe-cd","description":"A local MCP server for searching official PipeCD docs.","archived":false,"fork":false,"pushed_at":"2025-06-16T16:09:50.000Z","size":442,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-16T17:38:52.150Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pipe-cd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-20T09:41:11.000Z","updated_at":"2025-06-16T16:09:52.000Z","dependencies_parsed_at":"2025-06-16T17:24:06.451Z","dependency_job_id":"39f1c01c-00fe-47dd-91fa-962231acc1cd","html_url":"https://github.com/pipe-cd/docs-mcp-server","commit_stats":null,"previous_names":["pipe-cd/docs-mcp-server"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/pipe-cd/docs-mcp-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pipe-cd%2Fdocs-mcp-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pipe-cd%2Fdocs-mcp-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pipe-cd%2Fdocs-mcp-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pipe-cd%2Fdocs-mcp-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pipe-cd","download_url":"https://codeload.github.com/pipe-cd/docs-mcp-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pipe-cd%2Fdocs-mcp-server/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262363876,"owners_count":23299481,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-05T11:08:18.515Z","updated_at":"2025-06-28T02:31:19.231Z","avatar_url":"https://github.com/pipe-cd.png","language":"TypeScript","funding_links":[],"categories":["AI/ML"],"sub_categories":[],"readme":"# PipeCD Docs MCP Server\n\nA local MCP server for searching official PipeCD docs.\n\n## Overview\n\nThis server clones the official [PipeCD](https://github.com/pipe-cd/pipecd) docs from GitHub and provides simple full-text search and document retrieval APIs via the MCP protocol.  \nDocumentation is cloned into a temporary directory, and Markdown files are indexed by extracting their titles and content.\n\n## Usage\n\n### Prerequisites\n\n1. Create a PAT with `read:packages` scope. [Details](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry)\n\n2. Add the following config to your `.npmrc` file.\n\n```npmrc\n@pipe-cd:registry=https://npm.pkg.github.com\n//npm.pkg.github.com/:_authToken=YOUR_TOKEN\n```\n\n### Cursor\n\n### Quick Install with Cursor Deeplink\n\nFor Cursor users, you can install the MCP server with a single click using the deeplink below:\n\n[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=pipe-cd.docs-mcp-server\u0026config=eyJ0eXBlIjoic3RkaW8iLCJjb21tYW5kIjoibnB4IEBwaXBlLWNkL2RvY3MtbWNwLXNlcnZlckBsYXRlc3QifQ%3D%3D)\n\nThis will automatically configure the MCP server in your Cursor settings. After clicking the link, Cursor will prompt you to install the server.\n\n### Install Using npx\n\nAdd the following config to your mcp.json.\n\n```json\n{\n  \"mcpServers\": {\n    \"pipe-cd.docs-mcp-server\": {\n      \"type\": \"stdio\",\n      \"command\": \"npx\",\n      \"args\": [\n        \"@pipe-cd/docs-mcp-server@latest\"\n      ], \n    }\n  }\n}\n```\n\n\u003c!-- TODO: Add Claude Desktop etc. --\u003e\n\n## Tools\n\n### search_docs\n\nExecutes a full-text search on PipeCD docs.\n\n- Parameters:\n  - `query`: Search keywords (space-separated, AND search)\n  - `offset`: Start position for results\n  - `limit`: Number of results to return (default: 20)\n\n### read_docs\n\nReturns the content of the specified page.\n\n- Parameters:\n  - `path`: Relative path of the document (after \"docs/content/en/\")\n\n## Implementation Notes\n\n- Uses sparse-checkout to minimize clone size and speed up the process.\n- Titles are extracted from the Markdown front matter.\n- The search logic of `search_docs` is so simple for now.\n\n\n## Contributing\n\n### Code of Conduct\n\nPipeCD follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). Please read it to understand which actions are acceptable and which are not.\n\n### Get Involved\n\n- Slack: `#pipecd` channel on [CNCF Slack](https://cloud-native.slack.com/) for discussions related to PipeCD development.\n- Community Meeting: Every other Wednesdays. Search [here](https://www.cncf.io/calendar/).\n\n### Improvements\n\n- Bug: \n  - Please open an Issue and describe the problem. Or, open a PR with if it's easy one.\n- Enhancement / Feature Request:\n  - For small changes including docs or adding tests, please open a PR.\n  - For new features or big enhancement, basically, please open an Issue and discuss there before sending a PR. We cannot accept all requests in some cases.\n- Security issue:\n  - Send an email to [the core maintainers](https://github.com/pipe-cd/pipecd/blob/master/SECURITY.md). **DO NOT report on Issues.**\n\n## Release Flow\n\n1. Run the `prepare release` workflow with specifing the new version.\n   It will create a PR to update the version.\n2. Review the PR and merge it.\n3. Create a Release on GitHub with a new tag.\n   Then, the `release package` workflow will publish a new npm package.\n \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpipe-cd%2Fdocs-mcp-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpipe-cd%2Fdocs-mcp-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpipe-cd%2Fdocs-mcp-server/lists"}