Repository files navigation

A local MCP server for searching official PipeCD docs.

This server clones the officialPipeCD docs from GitHub and provides simple full-text search and document retrieval APIs via the MCP protocol.
Documentation is cloned into a temporary directory, and Markdown files are indexed by extracting their titles and content.

1. Create a PAT withread:packages scope.Details

2. Add the following config to your.npmrc file.

@pipe-cd:registry=https://npm.pkg.github.com//npm.pkg.github.com/:_authToken=YOUR_TOKEN

For Cursor users, you can install the MCP server with a single click using the deeplink below:

This will automatically configure the MCP server in your Cursor settings. After clicking the link, Cursor will prompt you to install the server.

Add the following config to your mcp.json.

{"mcpServers": {"pipe-cd.docs-mcp-server": {"type":"stdio","command":"npx","args": ["@pipe-cd/docs-mcp-server@latest"      ],     }  }}

Executes a full-text search on PipeCD docs.

• Parameters:
  • query: Search keywords (space-separated, AND search)
  • offset: Start position for results
  • limit: Number of results to return (default: 20)

Returns the content of the specified page.

• Parameters:
  • path: Relative path of the document (after "docs/content/en/")

• Uses sparse-checkout to minimize clone size and speed up the process.
• Titles are extracted from the Markdown front matter.
• The search logic ofsearch_docs is so simple for now.

PipeCD follows theCNCF Code of Conduct. Please read it to understand which actions are acceptable and which are not.

• Slack:#pipecd channel onCNCF Slack for discussions related to PipeCD development.
• Community Meeting: Every other Wednesdays. Searchhere.

• Bug:
  • Please open an Issue and describe the problem. Or, open a PR with if it's easy one.
• Enhancement / Feature Request:
  • For small changes including docs or adding tests, please open a PR.
  • 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.
• Security issue:
  • Send an email tothe core maintainers.DO NOT report on Issues.

1. Run theprepare release workflow with specifing the new version.It will create a PR to update the version.
2. Review the PR and merge it.
3. Create a Release on GitHub with a new tag.Then, therelease package workflow will publish a new npm package.