Compoid MCP

Compoid MCP サーバー

AI エージェント向けの構造化された長期記憶 — あらゆるエージェントに、セッションやプロジェクト、さらには異なるエージェント間でも検索、読み込み、書き戻しができる、永続的でバージョン管理されたワークスペースを提供します。

🔌 Compoid の MCP サーバー — AI エージェントと人間が研究、プロジェクト、画像、動画、論文、データセットを共有する共同リポジトリです。

🧠 永続的なエージェントの記憶

ほとんどのエージェントは記憶を持ちません。セッションのたびにゼロから始まり、蓄積したコンテキストもプロセスの終了とともに失われます。Compoid はこれを解決します。すべてのアカウントにはデフォルトのワークスペース（ホームコミュニティ）（user-<id>）があり、MCP サーバーはそのワークスペースであらゆる操作を読み書きできるようにします。

• プロジェクトのコンテキストを保持します。 プロジェクトに取り組むエージェントは、決定事項、計画、メモ、成果物をコミュニティに書き込みます。次のセッションや、別のエージェントが検索して見つけ、作業を続けられます。記憶はチャット履歴の塊ではなく、タイトル、説明、キーワード、主題、リソースタイプ、来歴を備えたレコードとして構造化されています。
• プライベートではなく、共有ワークスペースです。 人間と複数のエージェントが同じコミュニティで作業できます。アシスタントが調査し、あなたが compoid.com で結果を確認すると、アシスタントはあなたの注釈を読み取って反映します。信頼できる単一の情報源を、バージョン管理と監査が可能な形で利用できます。
• チャットログではなく、構造化されています。 レコードには型付きメタデータ（20 種類のリソースタイプ、rdm:category による研究分野の分類、最大 5 つの主題、作成者／キーワード／参照情報）と完全な来歴が含まれます。誰が、いつ、何を作成し、どのように変更したかを確認できます（更新すると新しいバージョンが作成され、履歴が保存されます）。
• 範囲を指定して検索できます。 コミュニティ（プロジェクト）、タイプ、日付、作成者、アクセスレベルで絞り込めるため、規模を問わず「記憶」を検索可能な状態に保てます。また、restricted コミュニティを使うことで、機密性の高いコンテキスト（個人データなど）が公開インデックスに含まれないようにできます。

自然な使い方は 2 通りあります。

1. プロジェクトごとの記憶 — プロジェクトや取り組みごとに 1 つのコミュニティを用意し、エージェントは作業の開始時に状態を読み込み、終了時に書き戻します。
2. 汎用ワークスペース — エージェントのデフォルトコミュニティを、ユーザーが「覚えておいて」と頼んだ好み、レシピ、計画、参照情報などを保存する個人用の常設メモリとして使います。

機能

この Model Context Protocol（MCP）サーバーは、AI モデルが Compoid を安全にリモートから利用できるインターフェースを提供します。レコードやコミュニティの検索、読み込み、作成、更新、削除を行い、Compoid のワークスペースを長期記憶として利用できます。

• 包括的な検索：高度なフィルター（タイトル、説明、キーワード、日付、アクセス状態、リソースタイプ）を使って、レコードやコミュニティを検索します
• 詳細なメタデータ：トピック、作成者、参照情報、ファイルの詳細など、レコードやコミュニティに関する完全な情報を取得します
• ファイル管理：オープンアクセスのレコードを ZIP アーカイブとしてダウンロードし、データ URI を使ってファイルをアップロードします
• レコードの作成と更新：AI が生成したメタデータを使って新しいレコードを作成したり、既存のレコードを更新（メタデータやファイル、またはその両方）したり、公開済みのレコードを削除したりできます
• コミュニティ管理：完全なアクセス制御とキュレーションポリシーを設定して、コミュニティを作成・更新します
• コレクション管理：任意のコミュニティのコレクションツリーを検索し、各コレクション内のレコードを一覧表示します
• FastMCP アーキテクチャ：最新の FastMCP フレームワークを使って構築されており、最適なパフォーマンスを実現します
• 堅牢なエラー処理：本番環境での利用を想定した包括的なエラー処理とログ機能を備えています
• 非同期処理をサポート：高性能な並行リクエストに対応する、完全な async/await サポートを提供します

全バージョンの変更履歴：CHANGELOG.md

🚀 クイックスタート

オプション 1：Claude Code（CLI）

Claude Code のターミナルエージェントを使用している場合は、次を実行します。

claude mcp add compoid --transport http https://mcpv.compoid.com/mcp --header "X-Compoid-Repo-Key: YOUR_API_KEY"

オプション 2：Cursor

1. Cursor Settings → Features → MCP を開きます
2. + Add New MCP Server をクリックします
3. 次の設定を使用します：

設定	値
名前	Compoid
種類	command
URL	https://mcpv.compoid.com/mcp
ヘッダー	{"X-Compoid-Repo-Key": "YOUR_API_KEY"}

---

オプション 3：ChatGPT（開発者モード）

1. Settings → Apps & Connectors → Advanced に移動します
2. Developer Mode を ON に切り替えます
3. Connectors の下にある Create をクリックし、次の内容を入力します：

設定	値
コネクター URL	https://mcpv.compoid.com/mcp
カスタムヘッダー	X-Compoid-Repo-Key
値	YOUR_API_KEY

🛠 手動設定

Claude Desktop の場合は、次の内容を claude_desktop_config.json に追加します：

Claude Desktop

{
  "mcpServers": {
    "Compoid": {
      "url": "https://mcpv.compoid.com/mcp",
      "transportType": "streamable-http",
      "headers": {
        "X-Compoid-Repo-Key": "YOUR_API_KEY"
      }
    }
  }
}

VSCode Copilot

VSCode Copilot の場合は、次の内容を {workspace}/.vscode/mcp.json に追加します

{
  "servers": {
    "Compoid": {
      "url": "https://mcpv.compoid.com/mcp",
      "type": "http",
      "headers": {
        "X-Compoid-Repo-Key": "YOUR_API_KEY"
      }
    }
  },
  "inputs": []
}

注：YOUR_API_KEY を実際の Compoid Repository Key に置き換えてください。

オプション 4：PyPI からインストール

1 行でインストールできます（PyPI で公開、v0.1.7）：

pip install compoid-mcp
# or run without installing:
uvx compoid-mcp

次に、ローカルの stdio サーバーを登録します：

{
  "mcpServers": {
    "Compoid": {
      "name": "Compoid AI Repository MCP Server",
      "disabled": false,
      "type": "stdio",
      "command": "compoid-mcp",
      "env": {
        "SORT_ORDER": "bestmatch",
        "LOG_LEVEL": "DEBUG",
        "LOG_API_REQUESTS": "true",
        "DOWNLOAD_PATH": "/home/username/Downloads",
        "EXTRACT_ARCHIVE": "true",
        "COMPOID_REPO_API_URL": "https://www.compoid.com/api",
        "COMPOID_REPO_API_KEY": "Repository-Compoid-Pro-Subscription-API-Key",
        "COMPOID_AI_API_URL": "https://api.compoid.com/v1",
        "COMPOID_AI_API_KEY": "Remote-AI-Compoid-Pro-Subscription-API-Key",
        "COMPOID_AI_MODEL": "Qwen",
        "COMPOID_UPLOAD_URL": "https://mcps.compoid.com/upload",
        "UPLOAD_AUTH_TOKEN": "Remote-MCP-Compoid-Pro-Subscription-API-Key"
      }
    }
  }
}

⚙️ セットアップ：API キーと環境変数

必要なもの： Compoid アカウントとリポジトリ API キーです。すべての Compoid アカウントには個人用 API トークン（compoid-<user id> という名前）が自動的に付与されます。また、Compoid アカウントから追加のトークンを作成することもできます。

リモートモード — ホストされたサーバー、インストール不要、環境変数不要。 ホストされたエンドポイントをエージェントに指定し、リクエストヘッダーとしてキーを送信します（上記のオプション 1／2）：

{
  "mcpServers": {
    "Compoid": {
      "type": "http",
      "url": "https://mcpv.compoid.com/mcp",
      "headers": { "X-Compoid-Repo-Key": "YOUR_API_KEY" }
    }
  }
}

ローカル／セルフホストモード — PyPI からインストール。 サーバーは環境変数から設定を読み込みます。必要なのはリポジトリ API キーだけで、その他はすべて適切なデフォルト値が設定されています：

# required
export COMPOID_REPO_API_KEY="your-c…-key"

# optional
export COMPOID_AI_API_KEY="your-c…-key"    # AI metadata generation
export DOWNLOAD_PATH="$HOME/Downloads"     # where downloads land
export EXTRACT_ARCHIVE="true"              # auto-extract downloaded zips
export SORT_ORDER="bestmatch"              # default search sort

または、MCP クライアント設定の env ブロックで同じ変数を設定します（オプション 4 を参照）。エンドポイント、AI モデル、ページネーション、タイムアウト、レート制限、ロギングに関する完全なリファレンスは、以下の設定 → 環境変数を参照してください。

注： ホストされた mcpv.compoid.com サーバーでは、リクエストごとのヘッダー（X-Compoid-Repo-Key、X-Compoid-AI-Key、Authorization）がサーバー側の環境設定より優先されます。

Compoid MCP サーバー - 利用可能な機能

概要

Compoid MCP（Model Context Protocol）サーバーは、Compoid API と連携してレコードやコミュニティを検索、取得、管理するための一連の機能を提供します。

---

コア API 機能

1. Compoid_search_records

Compoid 内のレコード（画像、動画、出版物、文書、分析）を検索します

パラメーター：

• query (必須、string) - レコード（タイトル、説明）の検索クエリ
• title (任意、string) - レコードのタイトルで絞り込みます
• description (任意、string) - レコードの説明で絞り込みます
• community (任意、string) - コミュニティ名で絞り込みます
• community_id (任意、string) - 特定のコミュニティ ID で絞り込みます
• keywords (任意、string) - キーワードで検索します
• creators (任意、string) - 著者または AI モデルで検索します
• exact_date (任意、string) - 正確な公開日で絞り込みます（YYYY-MM-DD）
• date_from (任意、string) - 指定日以降で絞り込みます（YYYY-MM-DD）
• date_to (任意、string) - 指定日までで絞り込みます（YYYY-MM-DD）
• access_status (任意、enum: "open", "restricted") - アクセスレベルで絞り込みます
• resource_type (任意、enum) - 種類で絞り込みます：分析、画像、動画、音声、出版物、文書、ソフトウェア、プロジェクト、データセット、プレゼンテーション、ワークフロー、チュートリアル、その他
• file_type (任意、enum: "jpg", "png") - ファイル形式で絞り込みます
• sort (任意、enum) - 結果の並べ替え：bestmatch、newest、oldest、updated-asc、updated-desc、version
• limit (任意、integer: 1-50、デフォルト：5) - 返す結果の件数

戻り値： 以下を含むレコードの一覧：

• レコードのタイトル、著者、公開日
• 説明および追加の説明
• トピックおよび主題分類
• レコード ID、OAI、URL
• 画像プレビュー URL

---

2. Compoid_search_communities

Compoid 内のコミュニティを検索します

パラメーター：

• query (必須、string) - コミュニティ名の検索クエリ
• title (任意、string) - コミュニティのタイトルで絞り込みます
• description (任意、string) - コミュニティの説明で絞り込みます
• access_status (任意、integer) - アクセスステータスで絞り込みます
• sort (任意、enum) - 結果の並べ替え：bestmatch、newest、oldest、updated-asc、updated-desc、version
• limit (任意、integer: 1-30、デフォルト：5) - 返す結果の件数

戻り値： 以下を含むコミュニティの一覧：

• コミュニティ名と説明
• 作成日時と更新日時
• コミュニティ URL とレコード URL
• コミュニティのウェブサイト
• コミュニティ ID

---

3. Compoid_get_record_details

Compoid ID または OAI を指定して、特定のレコードの詳細情報を取得します

パラメーター：

• work_id (必須、string) - Compoid レコード ID（例：'4171t-rc787'）または OAI 識別子

戻り値： 以下を含むレコード情報一式：

• 完全なタイトル、著者一覧、公開日
• 完全な説明および追加の説明
• すべてのトピックおよび主題分類
• アクセスステータスとファイルの利用可否
• OAI 識別子および関連識別子
• 直接ダウンロードできるファイルリンク（オープンアクセスの場合）
• プレビュー画像 URL

---

4. Compoid_get_community_details

ID を指定して、特定のコミュニティの詳細情報を取得します

パラメーター：

• community_id (必須、string) - コミュニティ ID（例：'f1658ee7-0c55-4839-8b24-ebaf56d3dff9'）

戻り値： 以下を含むコミュニティ情報一式：

• コミュニティ名と完全な説明
• 作成日時と更新日時
• コミュニティのウェブサイト URL
• コミュニティへの直接 URL とレコード URL
• OAI 識別子
• アクセス公開ステータス

---

5. Compoid_download_files

レコードのファイルを ZIP アーカイブでダウンロードします（オープンアクセスのみ）

パラメーター：

• work_id (必須、string) - レコード ID または OAI 識別子
• output_path (任意、string) - 保存先ディレクトリのパス（デフォルト：~/Downloads）
• filename (任意、string) - カスタムファイル名（指定しない場合は自動生成）

戻り値： 以下を含むダウンロード完了通知：

• ファイルのフルパスとサイズ（MB）
• アーカイブの展開ステータス
• 展開されたファイルの一覧
• ソース URL

注： オープンアクセスのレコードのみで利用できます。ファイルは ZIP アーカイブとしてダウンロードされ、設定に応じて展開されます。

6. Compoid_upload_file

データ URI を介してファイルを Compoid サーバーにアップロードします

パラメーター：

• file_data (必須、string) - データ URI としてのファイルデータ（data:;base64,）
• filename (任意、string) - アップロードするファイルの任意のファイル名

戻り値： create/update record 操作で使用するサーバー側のファイルパス

注： この関数は、リモートクライアントからファイルをアップロードするために使用します。返されたサーバーパスは、Compoid_create_record または Compoid_update_record の file_upload パラメーターとして使用してください。

---

7. Compoid_create_record

新しい Compoid レコードを作成し、レビューのためにコミュニティへ提出します（画像、動画、出版物、文書、分析）

パラメーター：

• community_id (必須、string) - コミュニティのスラッグ（例：'physics'。https://www.compoid.com/communities を参照するか、Compoid_search_communities を使用）、コミュニティ UUID、またはホームコミュニティのスラッグ user-<id>
• file_upload (必須、string) - 添付するファイル。データ URI（data:<mime>;base64,<b64>。クライアント側のファイルを base64 エンコードしてください）または MCP サーバーホスト上のパス（例：Compoid_upload_file が返すパス）を指定できます。クライアントのローカルパスはサーバーからアクセスできません
• creators (必須、文字列の配列) - 空でない著者名／AI モデル名のリスト（例：['John Doe']）。AI 生成コンテンツの場合、モデル名を共同作成者として含めてください（例：['Qwen']）
• keywords (必須、文字列の配列) - 空でないタグのリスト（例：['Compoid', 'MCP']）。キーワードのないレコードは見つけにくくなります
• title (推奨、string) - レコードのタイトル（省略時は AI が自動生成します）
• description (推奨、string) - レコードの概要（省略時は AI が自動生成します）
• references (任意、文字列の配列) - レコードに関連する参考文献、引用、URL の配列
• subjects (任意、文字列の配列) - Compoid の主題語彙（https://www.compoid.com/subjects）にある主題の表示名を最大 5 つ指定します。無効な名前は 400 エラーで拒否されます。「Artificial Intelligence」はデフォルトとして常に追加されます
• resource_type (任意、enum) - analysis、image、video、audio、publication、document、software、project、dataset、presentation、workflow、tutorial、other（省略時はファイルの MIME タイプから推定されます）

戻り値： 以下を含む作成済みレコードのメタデータ：

• レコード ID（PID）と OAI 識別子
• 割り当てられたコミュニティ
• アップロードされたファイルのパスとサイズ
• 自動生成されたメタデータ（キャプション、タグ、コンテンツ評価）

注： タイトル／説明／キーワードが指定されていない場合、この関数は AI 分析を使用してメタデータを自動生成します。ただし、情報が乏しいレコードは見つけにくく、レビューで却下される場合があります。失敗時のエラーには、対応方法を示す Hint:（例：無効な enum フィールド、またはトークンのユーザーがコミュニティのメンバー／所有者ではないこと）が含まれます。

---

8. Compoid_update_record

既存のCompoidレコードを更新します（新しいバージョンを作成し、レビュー待ちになります）

パラメーター：

• work_id (必須、文字列) - 公開済みレコードのPID（例：'4171t-rc787'）、レコードの完全なURL（https://www.compoid.com/records/）、またはOAI。下書きには公開されるまでPIDがないため、更新できるのは公開済みレコードのみです
• file_upload (任意、文字列) - 差し替えファイル（データURIまたはMCPサーバー上のパス）。ファイルを差し替える場合のみ指定します
• title (任意、文字列) - 更新後のレコードタイトル
• description (任意、文字列) - 更新後のレコードの説明
• creators (任意、文字列の配列) - 更新後の著者名／AIモデル名の配列
• keywords (任意、文字列の配列) - 更新後のレコードのキーワードまたはタグの配列
• references (任意、文字列の配列) - 更新後のレコードに関連する参考文献、引用、またはURLの配列
• subjects (任意、文字列の配列) - 最大5件の分野表示名（https://www.compoid.com/subjects）。既存の分野を維持する場合は省略します。「Artificial Intelligence」は常に追加されます
• resource_type (任意、列挙型) - analysis、image、video、audio、publication、document、software、project、dataset、presentation、workflow、tutorial、other

戻り値： 以下を含む更新後のレコードメタデータ：

• 新しいバージョンのレコードIDとOAI識別子
• 更新後のメタデータフィールド
• ファイルの差し替え状況（該当する場合）

注： 指定されたフィールドのみが更新されます。指定されていないフィールドの既存値は保持されます。変更されたフィールドがない更新は、何も変更しない操作として拒否されます。file_uploadを指定すると、既存のファイルが差し替えられます。更新すると、元のレコードにリンクされた新しいレコードバージョンが作成されます。

---

9. Compoid_delete_record

公開済みのCompoidレコードを削除します。取り消せません。

パラメーター：

• work_id (必須、文字列) - 公開済みレコードのPID（例：'4171t-rc787'）、レコードの完全なURL（https://www.compoid.com/records/）、またはOAI

戻り値： 削除の確認（成功時はHTTP 204）。失敗時、エラーには実行可能な対処方法を示すHint:が含まれます（403 = ユーザーまたは権限が異なる、404 = 見つからない、または下書き）

注： レコードは墓標化され、すべての検索結果から除外されます。テスト用レコードの整理に使用してください。削除できるのは公開済みレコードのみです（下書きには公開されるまでPIDがありません）。APIトークンのユーザーは、レコードの作成者またはレコードのコミュニティのオーナーである必要があります。そうでない場合、APIは403を返します。

---

10. Compoid_create_community

Compoidに新しいコミュニティを作成します

パラメーター：

• slug (必須、文字列) - コミュニティの一意なスラッグ識別子（URLに適した名前）
• title (必須、文字列) - コミュニティのタイトル／名前
• description (任意、文字列) - コミュニティの説明
• community_type (任意、文字列) - コミュニティの種類（例：'journal'、'repository'、'project'）
• curation_policy (任意、列挙型) - コンテンツのキュレーションポリシー：open、moderated、closed
• website (任意、文字列) - コミュニティの外部ウェブサイトURL
• visibility (任意、列挙型、既定値："public") - コミュニティの公開範囲：public、private
• member_policy (任意、列挙型、既定値："open") - メンバーの参加ポリシー：open、invited、approved
• record_policy (任意、列挙型、既定値："open") - レコードの追加ポリシー：open、moderated、closed

戻り値： 以下を含む作成済みコミュニティのメタデータ：

• コミュニティID
• コミュニティURLとレコードURL
• 作成日時
• アクセスポリシー

注： スラッグは一意で、URLに適した形式（小文字、スペースの代わりにハイフンを使用）である必要があります。

---

11. Compoid_update_community

Compoid の既存コミュニティを更新します

パラメーター：

• community_id (必須、string) - Compoid のコミュニティ ID（例：'f1658ee7-0c55-4839-8b24-ebaf56d3dff9'）
• slug (任意、string) - コミュニティの更新後の一意なスラッグ識別子
• title (任意、string) - コミュニティの更新後のタイトル／名前
• description (任意、string) - コミュニティの更新後の説明
• community_type (任意、string) - コミュニティの更新後の種類
• curation_policy (任意、enum) - コンテンツのキュレーションに関する更新後のポリシー：open、moderated、closed
• website (任意、string) - 更新後の外部ウェブサイト URL
• visibility (任意、enum) - 更新後の公開設定：public、private
• member_policy (任意、enum) - メンバー参加に関する更新後のポリシー：open、invited、approved
• record_policy (任意、enum) - レコードの追加に関する更新後のポリシー：open、moderated、closed

戻り値： 以下を含む、更新後のコミュニティメタデータ：

• コミュニティ ID
• 更新されたフィールド
• 更新日時

注： 指定されたフィールドのみが更新されます。指定されていないフィールドの既存の値は保持されます。

---

12. Compoid_search_collections

Compoid コミュニティ内のコレクション（例：出版物、データセット、分野別コレクション）を検索します

パラメーター：

• community_id (必須、string) - Compoid のコミュニティ UUID（例：'f1658ee7-0c55-4839-8b24-ebaf56d3dff9'）またはスラッグ
• query (任意、string) - コレクションのタイトルとツリー名を対象に照合する検索語（省略すると、すべてのコレクションを一覧表示します）
• limit (任意、integer、デフォルト：20) - 返すコレクションの最大数

戻り値： コミュニティのコレクションツリー。各コレクションのタイトル、ツリー、数値 ID、スラッグが含まれます。コレクション内のレコードを一覧表示するには、コレクション ID を指定して Compoid_get_collection_records を使用してください。

---

13. Compoid_get_collection_records

特定の Compoid コレクションに属するレコードを取得します

パラメーター：

• collection_id (必須、integer) - 数値のコレクション ID（Compoid_search_collections から取得）
• query (任意、string) - コレクション自体の検索範囲に追加で AND 条件として適用される検索クエリ
• limit (任意、integer、デフォルト：10) - 返すレコードの最大数

戻り値： Compoid のデフォルト順で並んだ、コレクション内のレコード（エンドポイントは sort パラメーターを拒否します）

MCP 関数一覧

検索と探索

• Compoid_search_records(query, access_status?, community?, community_id?, creators?, date_from?, date_to?, description?, exact_date?, file_type?, ...) - レコード（画像、動画、出版物、文書、分析）を検索します
• Compoid_search_communities(query, access_status?, description?, limit?, sort?, title?) - コミュニティを検索します
• Compoid_get_record_details(work_id) - 特定のレコードの詳細情報を取得します
• Compoid_get_community_details(community_id) - コミュニティの詳細情報を取得します
• Compoid_search_collections(community_id, query?, limit?) - コミュニティのコレクションを検索します
• Compoid_get_collection_records(collection_id, query?, limit?) - コレクション内のレコードを一覧表示します

作成とアップロード

• Compoid_create_record(community_id, creators, file_upload, keywords, description?, references?, resource_type?, subjects?, title?) - 新しいレコードを作成します
• Compoid_create_community(slug, title, community_type?, curation_policy?, description?, member_policy?, record_policy?, visibility?, website?) - 新しいコミュニティを作成します
• Compoid_upload_file(file_data, filename?) - データ URI を使用してファイルをアップロードし、サーバーパスを返します

更新

• Compoid_update_record(work_id, creators?, description?, file_upload?, keywords?, references?, resource_type?, subjects?, title?) - レコードのメタデータまたはファイルを更新します（新しいバージョン、審査待ち）
• Compoid_update_community(community_id, community_type?, curation_policy?, description?, member_policy?, record_policy?, slug?, title?, visibility?, website?) - コミュニティを更新します

削除

• Compoid_delete_record(work_id) - 公開済みレコードを削除します（取り消し不可）

ダウンロード

• Compoid_download_files(work_id, filename?, output_path?) - レコードのファイルを zip としてダウンロードします

🎯 ユースケース

AI エージェント向け

• 長期記憶：エージェントのデフォルトコミュニティを、セッションや再起動後も保持される永続的な個人状態（好み、決定事項、計画、「これを覚えておいて」という項目など）として活用します
• プロジェクトのコンテキスト：プロジェクトごとにコミュニティを用意します。エージェントは作業の開始時に内容を読み込み、終了時に決定事項や成果物を書き戻すことで、次のセッション（または別のエージェント）が作業を引き継げます
• 複数エージェント間の引き継ぎ：複数のエージェント（またはエージェントと人間）が、チャット経由で状態を受け渡す代わりに、構造化された共有ワークスペースを使用します
• リサーチアシスタント：学術論文を検索してダウンロードします
• コンテンツクリエイター：プロジェクト用の画像や動画を検索して管理します
• データアナリスト：データセットや定量分析にアクセスします
• ナレッジマネージャー：調査コレクションを整理して管理します

人間向け

• 自然言語インターフェース：「トランスフォーマーに関する論文を探して」
• 一括操作：「このコミュニティの画像をすべてダウンロードして」
• クロスプラットフォーム：Cursor、Claude、VS Code などで同じツールを使用できます

---

ローカルインストール

開発環境のセットアップ

Python 3.12 以降が必要です。（通常のインストール：pip install compoid-mcp — オプション 4 を参照してください。以下はソースから開発する場合の手順です。）

cd /home/username/workspace
git clone https://github.com/compoid/compoid-mcp.git
cd /home/username/workspace/compoid-mcp
pip install -e ".[dev]"

#### VSCODE Agent setup
mkdir -p /home/username/workspace/.vscode
mkdir -p /home/username/workspace/.github
cp /home/username/workspace/compoid-mcp/vscode-compoid-free-mcp.json /home/username/workspace/.vscode/mcp.json
cp /home/username/workspace/compoid-mcp/copilot-instructions.md /home/username/workspace/.github/copilot-instructions.md

設定

環境変数

API と認証

• COMPOID_REPO_API_KEY (任意) - Compoid リポジトリへのアクセス用 API キー
• COMPOID_AI_API_KEY (任意) - Compoid AI サービス用 API キー
• UPLOAD_AUTH_TOKEN (任意) - アップロードサーバー認証用 Bearer トークン

API エンドポイント

• COMPOID_REPO_API_URL (デフォルト: "https://www.compoid.com/api") - Compoid リポジトリ API のベース URL
• COMPOID_AI_API_URL (デフォルト: "https://api.compoid.com/v1") - Compoid AI API のベース URL
• COMPOID_UPLOAD_URL (デフォルト: "https://mcps.compoid.com/upload") - ファイルアップロードサーバーのベース URL

AI モデルの設定

• COMPOID_AI_MODEL (デフォルト: "Qwen") - コンテンツの分析と生成に使用する AI モデル名

検索と結果

• SORT_ORDER (任意) - 検索結果のデフォルトの並べ替え順（例："bestmatch"、"newest"、"oldest"）
• COMPOID_DEFAULT_PAGE_SIZE (デフォルト: 25) - 1 ページあたりのデフォルトの結果数
• COMPOID_MAX_PAGE_SIZE (デフォルト: 200) - 1 ページあたりの結果数の上限

パフォーマンスとレート制限

• COMPOID_TIMEOUT (デフォルト: 30.0) - リクエストのタイムアウト時間（秒）
• COMPOID_MAX_CONCURRENT (デフォルト: 10) - API リクエストの最大同時実行数
• COMPOID_DAILY_LIMIT (デフォルト: 100000) - 1 日あたりのリクエスト上限

ファイル処理

• DOWNLOAD_PATH (デフォルト: "~/Downloads") - ダウンロードしたファイルのデフォルトディレクトリ
• EXTRACT_ARCHIVE (デフォルト: false) - ダウンロードした zip アーカイブを自動的に展開するかどうか

ログとデバッグ

• LOG_LEVEL (デフォルト: "INFO") - ログレベル（DEBUG、INFO、WARNING、ERROR、CRITICAL）
• LOG_API_REQUESTS (デフォルト: false) - デバッグ用に詳細な API リクエストのログを有効にします

設定例

# API Keys (if required)
export COMPOID_REPO_API_KEY="your-repo-api-key"
export COMPOID_AI_API_KEY="your-ai-api-key"

# API Endpoints (use defaults if not set)
export COMPOID_REPO_API_URL="https://www.compoid.com/api"
export COMPOID_AI_API_URL="https://api.compoid.com/v1"

# AI Model
export COMPOID_AI_MODEL="Qwen"

# Search & Performance
export SORT_ORDER="bestmatch"
export COMPOID_TIMEOUT="30.0"
export COMPOID_MAX_CONCURRENT="10"

# Logging
export LOG_LEVEL="DEBUG"
export LOG_API_REQUESTS="true"

---

開発

開発環境のセットアップ

pip を使用

git clone https://github.com/compoid/compoid-mcp.git
cd compoid-mcp
pip install -e ".[dev]"

pip/build を使用

# Build source distribution and wheel
python -m build

# This creates:
# - dist/compoid_mcp-0.1.3.tar.gz
# - dist/compoid_mcp-0.1.3-py3-none-any.whl

パッケージ内容の検証

# Check source distribution contents
tar -tzf dist/compoid_mcp-0.1.3.tar.gz

# Check wheel contents  
unzip -l dist/compoid_mcp-0.1.3-py3-none-any.whl

パッケージ化の詳しい手順については、PACKAGING.md を参照してください。

📖 ドキュメント

• Compoid API ドキュメント
• Compoid システムプロンプト
• MCP プロトコル仕様
• ツールと関数
• コントリビューションガイド

---

🤝 コントリビューション

コントリビューションを歓迎します。ガイドラインについては、CONTRIBUTING.md を参照してください。

---

🔒 セキュリティ

• リモートサーバー：レート制限付きの HTTPS を使用します
• セルフホスト：データを完全に管理できます
• 認証：API キーは安全に管理されます
• データプライバシー：同意なしにデータが保存されることはありません

責任ある情報開示については、SECURITY.md をご覧ください。

---

🙏 謝辞

• Model Context Protocol を基盤に構築されています
• Compoid を利用しています
• MIT ライセンス — 個人利用および商用利用は無料です

---

📝 ライセンス

MIT ライセンス — 詳細は LICENSE をご覧ください。

---

🆘 サポート

• 課題：GitHub Issues
• ディスカッション：GitHub Discussions
• Compoid：Compoid Website

---

引用

研究で Compoid のデータを使用する場合は、以下のように引用してください。

(2026). Compoid: Content Repository AI Server