canpoint-knowledge-mcp
面向业务项目的知识库 MCP。安装后,AI 助手可以直接检索和阅读你项目的知识库
文档:查大纲、混合检索、读全文与章节、沿文档引用关系跳转;项目发布后,
还能一键把最新的 docs/ 同步进知识库。
能做什么
查询 MCP(只读,绑定一个项目):
| 工具 | 能力 |
|---|---|
get_outline |
查看项目知识库的文档大纲(可按版本/分组过滤) |
search |
在项目范围内混合检索,命中结果带标题路径、父章节与行号 |
get_document |
按文档路径读取全文 |
get_section |
读取章节块及其父块、子块 |
hop |
沿文档之间的引用边跳转相邻内容 |
同步 MCP(发布后更新知识库):
| 工具 | 能力 |
|---|---|
sync_now(project_root) |
把业务项目 docs/ 下的最新文档提交到知识库,返回受理任务号;project_root 传业务项目的绝对根目录 |
sync_status(job_id) |
查询同步任务进度,done / failed 为终态 |
怎么用
前提:
- 一个可访问的 KB2 知识库服务(通常由团队统一部署,向管理员要地址)
- 通过 npm 使用时需要先安装 uv
启动前设置两个环境变量,把 MCP 绑定到服务和项目:
KB_SERVER_URL=http://your-kb-service:8001
KB_PROJECT_KEY=your-project
Claude Code 配置示例(.mcp.json):
{
"mcpServers": {
"kb2-query": {
"command": "npx",
"args": ["-y", "canpoint-knowledge-mcp"],
"env": {
"KB_SERVER_URL": "http://your-kb-service:8001",
"KB_PROJECT_KEY": "your-project"
}
},
"kb2-sync": {
"command": "npx",
"args": ["-y", "--package", "canpoint-knowledge-mcp", "kb2-sync-mcp"],
"env": {
"KB_SERVER_URL": "http://your-kb-service:8001",
"KB_PROJECT_KEY": "your-project"
}
}
}
}
也可以用 Python 方式安装运行:
pip install canpoint-knowledge-mcp # 提供 kb2-query-mcp / kb2-sync-mcp 命令
uvx canpoint-knowledge-mcp # 免安装直接运行查询 MCP
推荐的发布规则(写入业务项目的 AGENTS.md):
发布成功后调用同步 MCP 的 sync_now(project_root="<当前项目绝对根目录>");
取得并汇报已受理的 job_id 后继续发布流程;除非知识库索引完成是发布门禁,
否则不要等待或轮询 sync_status。
项目
- 仓库与完整文档:https://github.com/mjwyr/canpoint-mcp
- 作者:若清风
- 协议:Apache-2.0
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file canpoint_knowledge_mcp-0.1.1.tar.gz.
File metadata
- Download URL: canpoint_knowledge_mcp-0.1.1.tar.gz
- Upload date:
- Size: 55.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1365c4be1ec8469bfc72f83cfdab4f2bb5833250c4977c22e25f3ff912b9499f
|
|
| MD5 |
1c2c84695a4109677f5e1eb5cfaa1ffc
|
|
| BLAKE2b-256 |
56d1f6d0d62840df25002e478feb27cc42e22e7dde3d920d546e230eb051aa38
|
File details
Details for the file canpoint_knowledge_mcp-0.1.1-py3-none-any.whl.
File metadata
- Download URL: canpoint_knowledge_mcp-0.1.1-py3-none-any.whl
- Upload date:
- Size: 29.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5dbb4d0a945fe5e3970fc3ddea1b45f1afb8c80ef06329f2e3f762efd4b0233c
|
|
| MD5 |
0a73af1cdcf3324472577e4430818016
|
|
| BLAKE2b-256 |
c01d653a4cd2ddf062c403986b760ca7c3a3735a2ac454e3f7992488f00cb7c5
|