MCP Document Server

🚀 MCP ドキュメントサーバー

このサーバーは、Model Context Protocol (MCP) を実装したシンプルなサーバーで、ドキュメントの検索と取得を行うことができます。

✨ 主な機能

• MCP を使用したドキュメントの保存と検索
• 意味検索機能の提供
• Cursor やその他の MCP クライアントとの互換性
• プラグイン式のドキュメントサービスアーキテクチャ：
  • ローカル JSON ドキュメント保存のサポート
  • Confluence ワークスペースのドキュメント検索の統合
• HTML 形式のサポート

📦 インストール

1. 依存関係のインストール：

npm install

2. TypeScript コードのビルド：

npm run build

3. サーバーの起動：

npm run stdio

💻 使用例

基本的な使用法

このサーバーは Cursor と連携するように設計されています。search ツールを使用して、キーワードパラメータでドキュメントを検索できます。

search({
  keyword: "data"
})

高度な使用法

Cursor から直接新しいドキュメントを作成することができます。

create_document({
  title: "New Confluence Page",
  content: "This is a page created in Confluence",
  serviceId: "confluence"
})

📚 ドキュメント

ドキュメントサービス

アーキテクチャはプラグイン式のドキュメントサービスに基づいて設計されています。各サービスは、ドキュメントの検索と取得のための共通インターフェースを実装しています。

ローカル保存サービス

ローカル保存サービスは、ドキュメントをローカルファイルシステムに保存します。

• ドキュメントは data/documents/ ディレクトリに保存されます（自動作成）
• メタデータは data/documents.json ファイルに保存されます（自動作成）
• Markdown および HTML 形式のコンテンツをサポートしています

Confluence サービス

Confluence サービスは、Confluence REST API と CQL（Confluence Query Language）を使用して、ワークスペースのドキュメントを検索します。この機能を有効にするには、以下の環境変数を設定してください。

# Confluence 設定
export CONFLUENCE_BASE_URL="https://your-domain.atlassian.net/wiki"
export CONFLUENCE_USERNAME="your-email@example.com"
export CONFLUENCE_API_TOKEN="your-api-token"
export CONFLUENCE_SPACE="your-space-key"

サーバーを起動する前にこれらの変数を設定することができます。

CONFLUENCE_BASE_URL="https://your-domain.atlassian.net/wiki" \
CONFLUENCE_USERNAME="your-email@example.com" \
CONFLUENCE_API_TOKEN="your-api-token" \
CONFLUENCE_SPACE="your-space-key" \
npm run stdio

認証詳細

サービスは Basic 認証を使用し、あなたのメールアドレスと API トークンを使用します。認証情報は Base64 エンコード形式で Authorization ヘッダーに送信されます。

Authorization: Basic <base64-encoded-email:token>

ドキュメントの管理

ローカル保存サービスは初回使用時に自動的に data/documents ディレクトリと data/documents.json ファイルを作成します。これらのファイルはリポジトリに含まれておらず、必要に応じて生成されます。

サーバーの拡張

新しいドキュメントサービスの追加

MCP サーバーは拡張可能に設計されています。DocumentService インターフェースを実装するだけで、新しいサービスを追加することができます。

interface DocumentService {
  id: string;
  getByKeywords: (keywords: string[]) => Promise<Document[]>;
  createDocument?: (title: string, content: string) => Promise<Document>;
}

新しいサービスを追加するには：

1. src/services/ ディレクトリに新しいディレクトリを作成します。
2. DocumentService インターフェースを実装します。
3. src/services/index.ts でサービスを登録します。

いくつかの潜在的なドキュメントサービスの実装方向は以下の通りです。

• Google Drive：Google ドライブ API を接続してドキュメントの保存と検索を行います。
• OneDrive/SharePoint：Microsoft のドキュメントサービスを統合します。
• Notion：Notion ワークスペースのサポートを追加します。
• GitHub Wiki：GitHub ウィキに接続してドキュメントを管理します。
• カスタムデータベース：ドキュメントを SQL または NoSQL データベースに保存します。