PipeCD Docs

Provides a local MCP server to search and retrieve PipeCD docs via MCP protocols.

typescript

4

GitHub Stars

typescript

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

You can run a local MCP server that indexes PipeCD documentation and exposes simple search and retrieval APIs. This makes it easy to find and read PipeCD docs directly from your editor or MCP client.

How to use

Use the MCP client to connect to the local server and perform two main actions: search for docs by keywords and read specific pages by path. The server indexes Markdown docs and exposes two tools: search_docs for full-text search and read_docs for fetching a page by its relative path. You can build complex queries by combining keywords and navigate results to quickly locate the information you need.

How to install

Prerequisites you will need to run the server locally:

Install steps

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

Run and test

Once the MCP server configuration is in place, start it through your MCP client. After it starts, you can use the search_docs tool to find PipeCD docs by keywords, and read_docs to retrieve specific pages by their path under the docs content.

Notes

The server indexes documentation by extracting titles from Markdown front matter and the page content. It performs full-text indexing to enable fast search results. You can customize your usage by adjusting the search offset and limit when querying with your MCP client.

Available tools

search_docs

Executes a full-text search on PipeCD docs. Parameters include query, offset, and limit for controlling results.

read_docs

Returns the content of a specified page. Requires a relative path after docs/content/en/ to locate the document.