Sourcesync.ai

🚀 SourceSync.ai MCP サーバーガイド（日本語版）

このガイドでは、SourceSync.ai MCP サーバーのインストール、設定、使用方法について説明します。

🚀 クイックスタート

インストールと起動

依存関係のインストール

プロジェクトのルートディレクトリで以下のコマンドを実行して、必要な依存関係をインストールします。

npm install

サーバーの起動

プロジェクトをビルドした後、サーバーを起動します。

node dist/index.js

環境変数の設定

.env ファイルを作成し、以下の内容を追加します。

PORT=3001 # サービスが動作するポート。デフォルトは3001
DEBUG=false # デバッグログを有効にするかどうか。デフォルトはfalse

MCP の設定

新しい設定ファイルの作成

src/config/ ディレクトリに新しいファイル（例：custom-config.ts）を作成します。

export const config = {
  host: "localhost", // サービスがバインドするホストアドレス。デフォルトはすべてのインターフェース
  port: 3001,        // サービスが動作するポート。デフォルトは3001
  namespace: "",     // デフォルトの名前空間。空の場合は使用しない
  logLevel: "info"   // ログレベル：debug、info、warn、error。デフォルトはinfo
};

インストールと起動

npm install
node dist/index.js

✨ 主な機能

ドキュメント管理ツール

• getDocuments：指定された名前空間内のすべてのドキュメントを取得します。
• queryDocuments：クエリ条件に基づいて一致するドキュメントを取得します。
• addDocument：新しいドキュメントをナレッジベースに追加します。
• updateDocument：既存のドキュメントの内容を更新します。
• deleteDocument：指定されたドキュメントを削除します。

質問応答ツール

• answerQuestion：ナレッジベースの内容に基づいて質問に回答します。
• contextWindow：情報検索範囲を制御するためのコンテキストウィンドウサイズを設定します。
• retrievalMode：異なる検索モード（厳密、曖昧）を切り替えます。

💻 使用例

基本的な使用法

ドキュメント取得ワークフロー

1. getDocuments を使用し、includeConfig.parsedTextFileUrl: true を設定して、内容の URL を含むドキュメントを取得します。
2. レスポンスから URL を抽出します。
3. fetchUrlContent を使用して実際の内容を取得します。

{
  "name": "fetchUrlContent",
  "arguments": {
    "url": "https://example.com"
  }
}

📚 ドキュメント

トラブルシューティング

接続問題

1. パスの検証：設定内のすべてのパスが絶対パスであることを確認してください。
2. 権限の確認：サーバーファイルに実行権限があることを確認してください（chmod +x dist/index.js）。
3. 開発者モードの有効化：Claude Desktop で開発者モードを有効にし、MCP ログファイルを確認してください。
4. サーバーの直接実行：

   node /path/to/sourcesyncai-mcp/dist/index.js
   

5. AI クライアントの再起動：変更を加えた後、Claude Desktop または Cursor を完全に再起動してください。
6. 環境変数の確認：すべての必須環境変数が正しく設定されていることを確認してください。

デバッグログ

詳細なログを記録するには、DEBUG 環境変数を追加します。

DEBUG=true

開発情報

プロジェクト構造

• src/index.ts：メインエントリーファイルとサーバー設定
• src/schemas.ts：すべてのツールのスキーマ定義
• src/sourcesync.ts：SourceSync.ai API とのやり取りを行うクライアント
• src/sourcesync.types.ts：TypeScript の型定義

ビルドとテスト

# プロジェクトのビルド
npm run build

# テストの実行
npm test

📄 ライセンス

MIT

🔗 リンク

• SourceSync.ai ドキュメント
• SourceSync.ai API リファレンス
• モデルコンテキストプロトコル