ima-mcp-server

将 IMA 知识库 官方 OpenAPI 封装为标准 MCP（Model Context Protocol） 服务器，可在任何支持 MCP 的 agent 软件中检索、浏览、读取知识库内容。

特性

• ✅ 标准 MCP 协议（stdio 传输），兼容所有 MCP 客户端

• ✅ 9 个知识库工具：搜索、浏览、读取原文、读取笔记正文、添加网页、上传本地文件

• ✅ 凭证灵活配置（环境变量 / 配置文件）

• ✅ 零外部服务依赖，纯 Node.js 运行

Related MCP server: agentdocs-mcp

可用工具

笔记读取说明：IMA 笔记正文通过 openapi/note/v1/get_doc_content 读取。get_media_info 命中笔记（media_id 以 note_ 开头）时会自动附带 note_content 字段；也可用 get_note_content 传 note_id 直读。微信文章/网页/文件类则返回可访问 URL。

前置要求

• Node.js ≥ 18（内置 fetch）

• IMA OpenAPI 凭证：在 https://ima.qq.com/agent-interface 获取 Client ID 和 API Key

安装

git clone <repo> ima-mcp-server
cd ima-mcp-server
npm install

或直接将 server.mjs + package.json 拷贝到本地后 npm install。

快速安装使用（AI 指令）

下面两种方式任选其一，都能在 1 分钟内把本库装好并接进 MCP 客户端。

方式一：复制命令直接跑

把下面整段粘进终端（或交给任意 AI 编码助手执行），记得替换你的 client_id / api_key：

# 1. 拉代码 + 装依赖
git clone https://github.com/rowanlin-dev/ima-mcp-server.git ima-mcp-server
cd ima-mcp-server
npm install

# 2. 写凭证（配置文件方式，最省心）
mkdir -p ~/.config/ima
printf '%s' "你的_client_id" > ~/.config/ima/client_id
printf '%s' "你的_api_key"  > ~/.config/ima/api_key
chmod 600 ~/.config/ima/client_id ~/.config/ima/api_key

# 3. 验证：应列出 9 个工具（含 upload_file）
node test-protocol.mjs

方式二：把这段指令直接丢给你的 AI

请帮我本地安装并配置 ima-mcp-server（IMA 知识库的 MCP 服务器）：

1. git clone https://github.com/rowanlin-dev/ima-mcp-server.git ima-mcp-server 后 npm install；

2. 把 IMA 的 Client ID / API Key 写入 ~/.config/ima/client_id 和 ~/.config/ima/api_key，权限设 600；

3. 在我的 MCP 客户端（Claude Desktop / Cursor / Cline / WorkBuddy 等）配置里加一个 ima server：command: node，args: ["<绝对路径>/ima-mcp-server/server.mjs"]；

4. 跑 node test-protocol.mjs 确认输出 9 个工具后，告诉我怎么在对话里验证（例如说“列出我的所有知识库”）。 凭证我去 https://ima.qq.com/agent-interface 取，不要写进任何仓库或日志。

各客户端的完整 JSON 配置见下文「各 MCP 客户端配置」。

凭证配置（三选一）

方式 A：环境变量（推荐，配置在 MCP 客户端中）

IMA_CLIENT_ID=你的_client_id
IMA_API_KEY=你的_api_key

方式 B：兼容 ima-skill 的环境变量名

IMA_OPENAPI_CLIENTID=你的_client_id
IMA_OPENAPI_APIKEY=你的_api_key

方式 C：配置文件

mkdir -p ~/.config/ima
echo "你的_client_id" > ~/.config/ima/client_id
echo "你的_api_key" > ~/.config/ima/api_key

优先级：方式 A > 方式 B > 方式 C

各 MCP 客户端配置

以下配置中的路径请替换为你的实际路径。

Claude Desktop

配置文件位置：

• Windows: %APPDATA%\Claude\claude_desktop_config.json

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "ima": {
      "command": "node",
      "args": ["C:\\Users\\你的用户名\\ima-mcp-server\\server.mjs"],
      "env": {
        "IMA_CLIENT_ID": "你的_client_id",
        "IMA_API_KEY": "你的_api_key"
      }
    }
  }
}

Cursor

配置文件：~/.cursor/mcp.json（全局）或项目内 .cursor/mcp.json

{
  "mcpServers": {
    "ima": {
      "command": "node",
      "args": ["/Users/你的用户名/ima-mcp-server/server.mjs"],
      "env": {
        "IMA_CLIENT_ID": "你的_client_id",
        "IMA_API_KEY": "你的_api_key"
      }
    }
  }
}

Cline (VS Code)

在 Cline 设置 → MCP Servers → 添加：

{
  "ima": {
    "command": "node",
    "args": ["/path/to/ima-mcp-server/server.mjs"],
    "env": {
      "IMA_CLIENT_ID": "你的_client_id",
      "IMA_API_KEY": "你的_api_key"
    },
    "disabled": false,
    "autoApprove": []
  }
}

VS Code Copilot / Continue

{
  "mcpServers": {
    "ima": {
      "command": "node",
      "args": ["/path/to/ima-mcp-server/server.mjs"],
      "env": {
        "IMA_CLIENT_ID": "你的_client_id",
        "IMA_API_KEY": "你的_api_key"
      }
    }
  }
}

WorkBuddy

编辑 ~/.workbuddy/mcp.json，在 mcpServers 中添加上述 ima 条目，然后在连接器管理页面点击「Trust」启用。

验证

配置完成后，在 agent 软件中尝试：

"列出我的所有知识库"

如果返回知识库列表，说明配置成功。

也可手动测试协议：

node test-protocol.mjs

故障排查

与 ima-skill 的关系

本项目现已补齐本地文件上传（upload_file），功能与 ima-skill 基本对齐；如需笔记的创建/编辑等写操作或 WorkBuddy 免配置 OAuth 连接器，仍可使用 ima-skill；如需在其它 agent 软件中使用标准 MCP，用本项目。

安全说明

• 凭证仅作为 HTTP 头发送至 ima.qq.com，不发送至任何其它域名

• 凭证不会被记录到日志或文件

• import_urls 的 URL 由 IMA 服务端抓取，本地不发送文件内容

• upload_file 的文件字节仅直传至 IMA 托管的腾讯云 COS（由 create_media 返回的临时凭证授权），不经由任何第三方

License

MIT