mcpField
C
Compoid MCP

Compoid MCP

远程服务
github.com/compoid记忆与知识02 周前更新
代码仓库

关于 Compoid MCP

Compoid MCP 为 AI Agent 和协作团队提供可持续、可搜索且有版本记录的研究工作区。它将记录、社区和文件管理整合为共享记忆,支持跨会话及不同 Agent 延续项目工作。

主要功能

  1. 01搜索记录与社区并应用筛选条件
  2. 02读取记录及社区的详细元数据
  3. 03创建、更新和删除记录
  4. 04管理社区访问控制与集合
  5. 05下载开放访问文件并上传文件

适用场景

  1. 01跨会话保存项目决策与研究笔记
  2. 02让多个 Agent 和人员协作维护资料
  3. 03按类型、日期或访问权限查找研究记录
  4. 04获取开放访问记录中的文件

MCP 相关

提供远程或本地 MCP 服务,让客户端搜索、读取和管理 Compoid 工作区中的记录与社区,并处理文件。

配置

远程服务无需本地安装。选择你使用的客户端,复制配置或使用一键安装。

服务地址https://mcpv.compoid.com/mcp
一键复制安装命令
Claude CodeTerminal
Cursor.cursor/mcp.json
VS Code.vscode/mcp.json
Claude Desktopclaude_desktop_config.json
Windsurf~/.codeium/windsurf/mcp_config.json

命令在终端中运行;JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。

全部服务地址
Streamable HTTPhttps://mcpv.compoid.com/mcp需要授权

工具

14
参数类型必填说明
sortstring否
limitinteger否
querystring是
titlestring否
date_tostring否
creatorsstring否
keywordsstring否
communitystring否
date_fromstring否
file_typestring否
exact_datestring否
descriptionstring否
community_idstring否
access_statusstring否
resource_typestring否

详细介绍

Compoid MCP Server

License: MIT PyPI version Python 3.12+

面向 AI Agent 的结构化长期记忆——为任何 Agent 提供持久、带版本管理的工作区,让它可以跨会话、项目,甚至不同 Agent 搜索、读取和写入内容。

🔌 Compoid 的 MCP 服务——一个协作式存储库,AI Agent 和人类可在其中共享研究成果、项目、图片、视频、论文和数据集。

🧠 持久的 Agent 记忆

大多数 Agent 都有失忆问题:每次会话都从零开始,积累的上下文也会随着进程结束而消失。Compoid 解决了这个问题。每个账户都有一个默认工作区——其专属社区(user-<id>),MCP 服务将其作为完整的读写界面开放:

  • 持久保存的项目上下文。 Agent 在项目中将决策、计划、笔记和成果写入社区;下次会话或另一个 Agent 可以搜索、查找并继续工作。记忆经过结构化处理(包含标题、描述、关键词、主题、资源类型和来源信息的记录),而不是一大段聊天记录。
  • 共享工作区,而非私人空间。 人类和多个 Agent 可以在同一社区中协作:助手开展研究,你在 compoid.com 上查看结果,它再读取你的注释。所有内容都来自同一个事实来源,且有版本记录、可供审计。
  • 结构化内容,而非聊天记录。 记录包含类型化元数据(20 种资源类型、rdm:category 研究领域分类、最多 5 个主题、创建者/关键词/参考资料),以及完整的来源信息——记录了谁在何时创建了什么,以及内容如何变化(更新会生成新版本,并保留历史记录)。
  • 范围明确,易于搜索。 可按社区(项目)、类型、日期、创建者和访问级别筛选,让“记忆”在任何规模下都能查询;restricted 社区中的敏感上下文(如个人数据)不会进入公共索引。

两种常见用法:

  1. 按项目建立记忆——每个项目或计划对应一个社区;Agent 在开始工作时读取状态,并在结束时写回内容。
  2. 通用工作区——将 Agent 的默认社区作为持续存在的个人记忆:偏好、食谱、计划、参考资料,以及用户要求它“记住”的任何内容。

功能

此模型上下文协议(MCP)服务为 AI 模型提供安全的远程接口,以便与 Compoid 交互——搜索、读取、创建、更新和删除记录及社区,也就是将 Compoid 工作区用作长期记忆。

  • 全面搜索:使用高级筛选条件搜索记录和社区(标题、描述、关键词、日期、访问状态、资源类型)
  • 详细元数据:获取记录和社区的完整信息,包括主题、创建者、参考资料和文件详情
  • 文件管理:将开放访问的记录下载为 zip 压缩包,并通过 data URI 上传文件
  • 记录创建与更新:使用 AI 生成的元数据创建记录、更新现有记录(元数据和/或文件),或删除已发布的记录
  • 社区管理:创建和更新社区,并全面管理访问控制与策展策略
  • 集合管理:搜索任意社区的集合树,并列出每个集合中的记录
  • FastMCP 架构:基于最新的 FastMCP 框架构建,带来出色的性能
  • 健壮的错误处理:提供全面的错误处理和日志记录,适用于生产环境
  • 异步支持:全面支持 async/await,实现高性能并发请求

完整版本历史:CHANGELOG.md

🚀 快速开始

选项 1:Claude Code(命令行)

如果你使用 Claude Code 终端 Agent,请运行:

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. 使用以下设置:
设置值
NameCompoid
Typecommand
URLhttps://mcpv.compoid.com/mcp
Headers{"X-Compoid-Repo-Key": "YOUR_API_KEY"}

选项 3:ChatGPT(开发者模式)
  1. 前往 Settings → Apps & Connectors → Advanced
  2. 将 Developer Mode 切换为 ON
  3. 点击 Connectors 下的 Create,并输入:
设置值
Connector URLhttps://mcpv.compoid.com/mcp
Custom HeaderX-Compoid-Repo-Key
ValueYOUR_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 安装

一行命令即可安装(已发布到 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 账户和一个 Repository API Key。每个 Compoid 账户都会自动获得一个个人 API 令牌(名称为 compoid-<user id>);你也可以从 Compoid 账户创建其他令牌。

远程模式 — 托管服务,无需安装,无需环境变量。 将 Agent 指向托管端点,并将密钥作为请求标头发送(即上方的选项 1/2):

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

本地 / 可自托管模式 — 从 PyPI 安装。 服务从环境变量读取配置。唯一必需的变量是 Repository API Key;其他所有变量都有可用的默认值:

# 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 (必填,字符串) - 记录搜索查询(标题、描述)
  • title (可选,字符串) - 按记录标题筛选
  • description (可选,字符串) - 按记录描述筛选
  • community (可选,字符串) - 按社区名称筛选
  • community_id (可选,字符串) - 按指定社区 ID 筛选
  • keywords (可选,字符串) - 按关键词搜索
  • creators (可选,字符串) - 按作者或 AI 模型搜索
  • exact_date (可选,字符串) - 按确切发布日期筛选(YYYY-MM-DD)
  • date_from (可选,字符串) - 按起始日期筛选(YYYY-MM-DD)
  • date_to (可选,字符串) - 按截止日期筛选(YYYY-MM-DD)
  • access_status (可选,枚举:"open"、"restricted") - 按访问级别筛选
  • resource_type (可选,枚举) - 按类型筛选:analysis、image、video、audio、publication、document、software、project、dataset、presentation、workflow、tutorial、other
  • file_type (可选,枚举:"jpg"、"png") - 按文件格式筛选
  • sort (可选,枚举) - 排序结果:bestmatch、newest、oldest、updated-asc、updated-desc、version
  • limit (可选,整数:1-50,默认值:5) - 返回结果数量

返回: 记录列表,包括:

  • 记录标题、作者、发布日期
  • 描述和补充描述
  • 主题和学科分类
  • 记录 ID、OAI 和 URL
  • 图像预览 URL

2. Compoid_search_communities

在 Compoid 中搜索社区

参数:

  • query (必填,字符串) - 社区名称搜索查询
  • title (可选,字符串) - 按社区标题筛选
  • description (可选,字符串) - 按社区描述筛选
  • access_status (可选,整数) - 按访问状态筛选
  • sort (可选,枚举) - 排序结果:bestmatch、newest、oldest、updated-asc、updated-desc、version
  • limit (可选,整数:1-30,默认值:5) - 返回结果数量

返回: 社区列表,包括:

  • 社区名称和描述
  • 创建和更新时间戳
  • 社区 URL 和记录 URL
  • 社区网站
  • 社区 ID

3. Compoid_get_record_details

通过 Compoid ID 或 OAI 获取特定记录的详细信息

参数:

  • work_id (必填,字符串) - Compoid 记录 ID(例如,'4171t-rc787')或 OAI 标识符

返回: 完整的记录信息,包括:

  • 完整标题、作者列表、发布日期
  • 完整描述和补充描述
  • 所有主题和学科分类
  • 访问状态和文件可用性
  • OAI 标识符和相关标识符
  • 直接文件链接(如为开放访问)
  • 预览图像 URL

4. Compoid_get_community_details

通过 ID 获取特定社区的详细信息

参数:

  • community_id (必填,字符串) - 社区 ID(例如,'f1658ee7-0c55-4839-8b24-ebaf56d3dff9')

返回: 完整的社区信息,包括:

  • 社区名称和完整描述
  • 创建和更新时间戳
  • 社区网站 URL
  • 直接社区 URL 和记录 URL
  • OAI 标识符
  • 访问可见性状态

5. Compoid_download_files

将记录文件下载为 zip 存档(仅限开放访问)

参数:

  • work_id (必填,字符串) - 记录 ID 或 OAI 标识符
  • output_path (可选,字符串) - 保存目录路径(默认值:~/Downloads)
  • filename (可选,字符串) - 自定义文件名(未提供时自动生成)

返回: 下载确认信息,包括:

  • 完整文件路径和大小(MB)
  • 存档解压状态
  • 已解压文件列表
  • 源 URL

注意: 仅适用于开放访问记录。文件将以 zip 存档格式下载,并可根据配置选择是否解压。


6. Compoid_upload_file

通过数据 URI 将文件上传到 Compoid 服务

参数:

  • file_data (必需,字符串) - 文件数据,格式为数据 URI(data:;base64,)
  • filename (可选,字符串) - 上传文件的可选文件名

**返回:**服务器端文件路径,可用于创建或更新记录操作

**注意:**此函数用于从远程客户端上传文件。返回的服务器路径应作为 file_upload 参数,用于 Compoid_create_record 或 Compoid_update_record。


7. Compoid_create_record

创建新的 Compoid 记录并提交到社区审核(图像、视频、出版物、文档、分析)

参数:

  • community_id (必需,字符串) - 社区 slug(例如 'physics'——可浏览 https://www.compoid.com/communities,或使用 Compoid_search_communities)、社区 UUID,或个人主页社区 slug user-<id>
  • file_upload (必需,字符串) - 要附加的文件。接受数据 URI(data:<mime>;base64,<b64>——在客户端对文件进行 base64 编码)或 MCP 服务主机上的路径(例如 Compoid_upload_file 返回的路径)。服务器无法访问客户端本地路径
  • creators (必需,字符串数组) - 非空的作者 / AI 模型名称列表(例如 ['John Doe']);对于 AI 生成的内容,请将模型名称作为共同创作者(例如 ['Qwen'])
  • keywords (必需,字符串数组) - 非空的标签列表(例如 ['Compoid', 'MCP'])——不带关键词的记录很难被发现
  • title (推荐,字符串) - 记录标题(若未提供,由 AI 自动生成)
  • description (推荐,字符串) - 记录摘要(若未提供,由 AI 自动生成)
  • references (可选,字符串数组) - 与记录相关的参考资料、引文或 URL 数组
  • subjects (可选,字符串数组) - 最多 5 个来自 Compoid 学科词表(https://www.compoid.com/subjects)的学科显示名称;无效名称会导致 400 错误。始终会追加 "Artificial Intelligence" 作为默认值
  • resource_type (可选,枚举) - analysis、image、video、audio、publication、document、software、project、dataset、presentation、workflow、tutorial、other(若未提供,则根据文件 MIME 类型推断)

**返回:**创建的记录元数据,包括:

  • 记录 ID(PID)和 OAI 标识符
  • 社区归属
  • 上传的文件路径和大小
  • 自动生成的元数据(说明文字、标签、内容评级)

**注意:**如果未提供 title/description/keywords,该函数会通过 AI 分析自动生成元数据;但信息过少的记录很难被发现,也可能在审核时被拒绝。失败时,错误信息会包含可执行的 Hint:(例如指出哪个枚举字段无效,或说明令牌所属用户不是该社区的成员 / 所有者)。


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 记录。不可撤销。

参数:

返回: 删除确认(成功时为 HTTP 204)。失败时,错误会包含可执行的 Hint:(403 = 用户或权限错误,404 = 未找到或为草稿)

注意: 记录会被标记为已删除,并从所有搜索结果中移除——可用于清理测试记录。只有已发布的记录才能删除(草稿在发布前没有 PID)。API 令牌所属用户必须是记录创建者或记录所属社区的所有者,否则 API 会返回 403。


10. Compoid_create_community

在 Compoid 上创建新的社区

参数:

  • slug (必需,字符串) - 社区的唯一 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
  • 创建时间戳
  • 访问策略

注意: slug 必须唯一且适合用于 URL(小写,使用连字符代替空格)。


11. Compoid_update_community

更新 Compoid 上的现有社区

参数:

  • community_id (必填,字符串) - Compoid 社区 ID(例如,'f1658ee7-0c55-4839-8b24-ebaf56d3dff9')
  • slug (可选,字符串) - 更新后的社区唯一 slug 标识符
  • title (可选,字符串) - 更新后的社区标题/名称
  • description (可选,字符串) - 更新后的社区描述
  • community_type (可选,字符串) - 更新后的社区类型
  • curation_policy (可选,枚举) - 更新后的内容策展政策:open、moderated、closed
  • website (可选,字符串) - 更新后的外部网站 URL
  • visibility (可选,枚举) - 更新后的可见性设置:public、private
  • member_policy (可选,枚举) - 更新后的成员加入政策:open、invited、approved
  • record_policy (可选,枚举) - 更新后的记录添加政策:open、moderated、closed

返回: 更新后的社区元数据,包括:

  • 社区 ID
  • 已更新的字段
  • 更新时间戳

注意: 仅更新已提供的字段。未指定字段的现有值会保留。


12. Compoid_search_collections

搜索 Compoid 社区中的集合(例如,出版物、数据集、主题集合)

参数:

  • community_id (必填,字符串) - Compoid 社区 UUID(例如,'f1658ee7-0c55-4839-8b24-ebaf56d3dff9')或 slug
  • query (可选,字符串) - 与集合标题和树名称匹配的搜索词(省略则列出所有集合)
  • limit (可选,整数,默认值:20) - 要返回的最大集合数

返回: 社区的集合树,其中每个集合包含标题、树、数字 ID 和 slug。使用 Compoid_get_collection_records 并传入集合 ID 可列出其中的记录。


13. Compoid_get_collection_records

获取属于指定 Compoid 集合的记录

参数:

  • collection_id (必填,整数) - 数字集合 ID(来自 Compoid_search_collections)
  • query (可选,字符串) - 额外的搜索查询,并与集合自身的范围条件进行 AND 运算
  • limit (可选,整数,默认值:10) - 要返回的最大记录数

返回: 集合中的记录,按 Compoid 默认顺序排列(该端点不接受排序参数)

MCP Functions Inventory

搜索与发现
  • 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 Agent
  • 长期记忆:将 Agent 的默认社区用作持久的个人状态空间——保存偏好、决策、计划以及“记住这件事”等内容,使其在会话结束和重启后依然保留
  • 项目上下文:每个项目使用一个社区;Agent 在开始工作时读取,在结束时写回决策和成果,下次会话(或其他 Agent)即可从上次中断处继续
  • 多 Agent 交接:多个 Agent(或 Agent 与人类)共用同一个结构化工作空间,无需通过聊天传递状态
  • 研究助手:搜索并下载学术论文
  • 内容创作者:查找和管理项目所需的图片/视频
  • 数据分析师:访问数据集并进行定量分析
  • 知识管理者:组织和整理研究资料集
面向人类
  • 自然语言界面:“帮我找一些关于 transformers 的论文”
  • 批量操作:“下载这个社区中的所有图片”
  • 跨平台:在 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 端点
AI 模型配置
  • COMPOID_AI_MODEL (默认值:"Qwen") - 用于内容分析和生成的 AI 模型名称
搜索和结果
  • SORT_ORDER (可选) - 搜索结果的默认排序方式(例如:"bestmatch"、"newest"、"oldest")
  • COMPOID_DEFAULT_PAGE_SIZE (默认值:25) - 每页的默认结果数量
  • COMPOID_MAX_PAGE_SIZE (默认值:200) - 每页允许的最大结果数量
性能和速率限制
  • COMPOID_TIMEOUT (默认值:30.0) - 请求超时时间,单位为秒
  • COMPOID_MAX_CONCURRENT (默认值:10) - API 请求的最大并发数
  • COMPOID_DAILY_LIMIT (默认值:100000) - 每日请求上限
文件处理
  • 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。

📖 文档


🤝 贡献

欢迎贡献!请参阅 CONTRIBUTING.md 了解指南。


🔒 安全

  • 远程服务:使用 HTTPS 并实施速率限制
  • 可自托管:完全掌控您的数据
  • 身份验证:安全地管理 API 密钥
  • 数据隐私:未经同意不会存储任何数据

请参阅 SECURITY.md 了解负责任的漏洞披露方式。


🙏 致谢


📝 许可证

MIT 许可证——详情请参阅 LICENSE。


🆘 支持


引用

如果您在研究中使用 Compoid 数据,请引用:

(2026)。Compoid:内容存储库 AI 服务

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。