Skip to main content

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

Codex 配置示例(~/.codex/config.toml):

[mcp_servers.kb2-query]
type = "stdio"
command = "npx"
args = ["-y", "canpoint-knowledge-mcp"]

[mcp_servers.kb2-query.env]
KB_SERVER_URL = "http://your-kb-service:8001"
KB_PROJECT_KEY = "your-project"

[mcp_servers.kb2-sync]
type = "stdio"
command = "npx"
args = ["-y", "--package", "canpoint-knowledge-mcp", "kb2-sync-mcp"]

[mcp_servers.kb2-sync.env]
KB_SERVER_URL = "http://your-kb-service:8001"
KB_PROJECT_KEY = "your-project"

Windows 下若 npx 启动失败,可把 command 改为 cmdargs 改为 ["/c", "npx", "-y", "canpoint-knowledge-mcp"](env 表不变)。

推荐的发布规则(写入业务项目的 AGENTS.md):

发布成功后调用同步 MCP 的 sync_now(project_root="<当前项目绝对根目录>");
取得并汇报已受理的 job_id 后继续发布流程;除非知识库索引完成是发布门禁,
否则不要等待或轮询 sync_status。

项目

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

canpoint_knowledge_mcp-0.1.8.tar.gz (65.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

canpoint_knowledge_mcp-0.1.8-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

Details for the file canpoint_knowledge_mcp-0.1.8.tar.gz.

File metadata

  • Download URL: canpoint_knowledge_mcp-0.1.8.tar.gz
  • Upload date:
  • Size: 65.8 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

Hashes for canpoint_knowledge_mcp-0.1.8.tar.gz
Algorithm Hash digest
SHA256 0378cfc6d2495cbeeea86faa764bc98fdc6997fa4a8d4e04855f61c497b4ab8b
MD5 9fe013d5535823a2f5468ea64f866d4d
BLAKE2b-256 b3a40a2f8d1fc1696e89bc7c0e1d4f30a3736947313f3ddaec49715d3d7915c6

See more details on using hashes here.

File details

Details for the file canpoint_knowledge_mcp-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: canpoint_knowledge_mcp-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 34.1 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

Hashes for canpoint_knowledge_mcp-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 28946ced95d5278690755413ab6421d121d2c52b0b7bd79d75c165d685268fea
MD5 2b05910621b9495300f1b006dd925745
BLAKE2b-256 dffc290952c2a9bfd10f0e5b1b210a0b594aad752ef4015286663e374ff8bf4e

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.9

2 files

This release

0.1.8 This release

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page