PipeCD Docs MCP Server

PipeCD 文档 MCP 服务

用于搜索 PipeCD 官方文档的本地 MCP 服务。

概述

此服务会从 GitHub 克隆官方 PipeCD 文档，并通过 MCP 协议提供简单的全文搜索和文档检索 API。
文档会克隆到临时目录中，并通过提取标题和内容为 Markdown 文件建立索引。

用法

先决条件

1. 创建一个具有 read:packages 权限范围的 PAT。详情

2. 将以下配置添加到 .npmrc 文件中。

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

Cursor

使用 Cursor Deeplink 快速安装

Cursor 用户可以通过下方的 deeplink，一键安装 MCP 服务：

这会自动在 Cursor 设置中配置 MCP 服务。点击链接后，Cursor 会提示你安装该服务。

使用 npx 安装

将以下配置添加到 mcp.json。

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

工具

search_docs

对 PipeCD 文档执行全文搜索。

• 参数：
  • query：搜索关键词（以空格分隔，使用 AND 搜索）
  • offset：结果的起始位置
  • limit：返回结果数量（默认值：20）

read_docs

返回指定页面的内容。

• 参数：
  • path：文档的相对路径（位于 "docs/content/en/" 之后）

实现说明

• 使用 sparse-checkout 减少克隆内容并加快处理速度。
• 从 Markdown front matter 中提取标题。
• 目前 search_docs 的搜索逻辑非常简单。

贡献

行为准则

PipeCD 遵循 CNCF 行为准则。请阅读该准则，了解哪些行为可以接受，哪些不可以。

参与其中

• Slack：在 CNCF Slack 的 #pipecd 频道讨论 PipeCD 开发相关话题。
• 社区会议：每隔一个星期三举行。请在此处搜索。

改进

• Bug：
  • 请提交 Issue 并描述问题。如果问题很容易解决，也可以提交 PR。
• 改进 / 功能请求：
  • 对于文档修改或添加测试等小改动，请提交 PR。
  • 对于新功能或较大的改进，通常请先提交 Issue 并进行讨论，然后再提交 PR。某些情况下，我们无法接受所有请求。
• 安全问题：
  • 请给核心维护者发送电子邮件。请勿在 Issue 中报告。

发布流程

1. 运行 prepare release 工作流，并指定新版本。 这会创建一个用于更新版本的 PR。
2. 审核并合并 PR。
3. 在 GitHub 上使用新标签创建一个 Release。 随后，release package 工作流会发布新的 npm 包。