PipeCD Docs MCP Server

PipeCD Docs MCP Server

公式 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 のディープリンクを使ったクイックインストール

Cursor ユーザーは、以下のディープリンクを使ってワンクリックで 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 のフロントマターから抽出されます。
• 現時点での search_docs の検索ロジックは非常にシンプルです。

コントリビューション

行動規範

PipeCD は CNCF Code of Conduct に従っています。どのような行動が許容され、どのような行動が許容されないかを理解するため、内容をご確認ください。

参加方法

• Slack：PipeCD の開発に関する議論は、CNCF Slack の #pipecd チャンネルで行えます。
• コミュニティミーティング：隔週の水曜日に開催されます。こちらで検索してください。

改善提案

• バグ：
  • Issue を作成して問題を説明してください。簡単な修正であれば、PR を作成してもかまいません。
• 機能強化／機能リクエスト：
  • ドキュメントの変更やテストの追加など、小規模な変更の場合は PR を作成してください。
  • 新機能や大規模な機能強化の場合は、基本的に PR を送る前に Issue を作成し、そこで議論してください。場合によっては、すべてのリクエストを受け付けられないことがあります。
• セキュリティの問題：
  • コアメンテナーにメールで連絡してください。Issue では報告しないでください。

リリースの流れ

1. 新しいバージョンを指定して prepare release ワークフローを実行します。 バージョン更新用の PR が作成されます。
2. PR をレビューしてマージします。
3. 新しいタグを付けて GitHub でリリースを作成します。 その後、release package ワークフローによって新しい npm パッケージが公開されます。