Scrapbox Cosense MCP

🚀 Scrapbox と Cosense の MCP サーバードキュメント

このドキュメントは、Scrapbox と Cosense の MCP サーバーに関する機能、使い方、設定方法などを説明しています。

✨ 主な機能

get 操作

• 単一のエントリを取得: エントリの一意の識別子を指定することで、特定のエントリの内容を取得できます。
• すべてのエントリを取得: Scrapbox に保存されているすべてのエントリを取得できます。

post 操作

• 新しいエントリを作成: ユーザーはサーバーに新しいエントリデータ（タイトルとオプションの内容テキスト）を送信し、そのエントリの一意の識別子を取得できます。
• 既存のエントリを更新: エントリの一意の識別子を指定して、その内容を更新することができます。
• 特定のエントリを削除: エントリの一意の識別子を指定することで、特定のエントリを削除できます。

search 操作

• 基本検索: タイトルまたは内容に基づくキーワード検索をサポートし、一致するすべてのエントリの一意の識別子を返します。
• 高度な検索: 論理演算子（AND、OR、NOT など）を使用して複数のキーワードを組み合わせた複雑なクエリをサポートし、結果の範囲をさらに絞り込むことができます。

📚 ドキュメント

環境変数の設定

サーバーを正常に動作させるために、実行時に以下の環境変数を設定する必要があります。

1. COSENSE_PROJECT_NAME

   • タイプ：文字列
   • 説明：接続する Scrapbox または Cosense のプロジェクト名を指定します。
   • 例：my_project

2. COSENSE_SID

   • タイプ：文字列
   • 説明：Scrapbox または Cosense プラットフォームから提供される一意のセッション識別子で、認証に使用されます。
   • 例：abc123-def456-ghi789

API リクエスト形式

すべての API リクエストは JSON 形式で行います。

単一のエントリを取得

{
  "operation": "get",
  "id": "string"
}

リクエストの例：

{
  "operation": "get",
  "id": "12345"
}

新しいエントリを作成

{
  "operation": "post",
  "title": "string",
  "content": "string (オプション)"
}

リクエストの例：

{
  "operation": "post",
  "title": "私の新しいノート",
  "content": "今日はいい天気です。"
}

既存のエントリを更新

{
  "operation": "update",
  "id": "string",
  "new_title": "string (オプション)",
  "new_content": "string (オプション)"
}

リクエストの例：

{
  "operation": "update",
  "id": "12345",
  "new_title": "更新後のノートタイトル"
}

特定のエントリを削除

{
  "operation": "delete",
  "id": "string"
}

リクエストの例：

{
  "operation": "delete",
  "id": "12345"
}

エントリを検索

{
  "operation": "search",
  "query": "string",
  "logic": "basic" または "advanced"
}

リクエストの例：

{
  "operation": "search",
  "query": "ノート AND 天気",
  "logic": "advanced"
}

レスポンス形式

サーバーからのレスポンスはすべて JSON 形式で返されます。

操作成功

{
  "status": "success",
  "data": {
    // 具体的なデータは操作タイプによって異なります
  }
}

操作失敗

{
  "status": "error",
  "message": "string" // エラーメッセージの説明
}

📦 インストール

依存関係のインストール

必要な npm パッケージをインストールするには、以下のコマンドを実行します。

npm install

サーバーのビルド

本番環境用のサーバーをビルドします。

npm run build

開発モードでの自動リロード

開発中は、自動リロード機能を有効にして効率を向上させることができます。

npm run watch

💻 使用例

Claude Desktop の設定

Claude Desktop でこの MCP サーバーを使用するには、以下の手順で設定します。

1. Claude の設定ファイルを開きます。

   • MacOS：~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows：%APPDATA%/Claude/claude_desktop_config.json

2. mcpServers オブジェクトに以下の設定を追加します。

{
  "mcp_servers": {
    "scrapbox_cosense_server": {
      "type": "custom",
      "uri": "http://localhost:3000", // 実際のアドレスとポートに合わせて変更してください
      "env_vars": {
        "COSENSE_PROJECT_NAME": "my_project",
        "COSENSE_SID": "abc123-def456-ghi789"
      }
    }
  }
}

🔧 技術詳細

トラブルシューティング

一般的な問題

1. サーバーに接続できない

   • サーバーが起動していることを確認してください。
   • ネットワーク接続を確認し、ファイアウォールが通信をブロックしていないことを確認してください。

2. 認証に失敗する

   • COSENSE_SID が正しいことを確認してください。
   • COSENSE_PROJECT_NAME がターゲットのプロジェクト名と一致していることを確認してください。

3. 検索機能が正常に動作しない

   • 論理演算子の使用が期待どおりであることを確認してください。
   • キーワードのスペルを確認し、大文字小文字や記号の誤りによるマッチング失敗を避けてください。

サポートへの連絡

解決できない問題が発生した場合は、以下の方法で技術サポートチームに連絡してください。

• メール：support@scrapbox.com
• 電話：+86-123-456789