竹简文档

Claude Code 集成

在 Claude Code 中使用竹简文档 MCP 服务

Claude Code 集成

Claude Code 是 Anthropic 官方的命令行 AI 助手。通过集成竹简文档 MCP 服务,可以让 Claude Code 直接访问项目文档,获得更精准的代码辅助。

什么是 MCP?

MCP(Model Context Protocol)是 Anthropic 提出的模型上下文协议,允许 AI 助手通过标准化接口访问外部数据源和工具。

集成方式

竹简文档提供 两种 Claude Code 集成方式,可根据需求选择:

方式一:远程 MCP 服务(推荐)

通过 Streamable HTTP 端点连接,无需安装任何软件。适合大多数使用场景。

编辑 Claude Code 的配置文件:

  • 项目级配置: 项目根目录下创建 .claude/settings.json
  • 全局配置: 编辑 ~/.claude/settings.json

添加以下内容:

{
  "mcpServers": {
    "bamboo-document": {
      "type": "http",
      "url": "https://doc.x-lf.com/api/mcp"
    }
  }
}

type 字段说明

Claude Code CLI 使用 "type": "http" 来标识 Streamable HTTP 传输方式。 这是 CLI 工具的内部命名约定,与 MCP 规范中的 streamableHttp 指向同一协议。

配置完成后重启 Claude Code,MCP 服务将自动加载。

优势

无需安装、无需编译、跨平台支持。只要有网络连接即可使用,服务端自动维护文档内容。

方式二:一键安装(推荐)

使用 Claude Code CLI 提供的 mcp add 命令,一行命令即可完成安装:

# 安装竹简文档 MCP 服务
claude mcp add --transport http https://doc.x-lf.com/api/mcp

执行后 MCP 服务将自动注册到你的 Claude Code 配置中,立即生效,无需重启或编辑任何配置文件。

跨编辑器支持

如果你同时使用 Cursor、Windsurf 等其他支持 MCP 的编辑器,可以使用社区工具一键安装到多个环境:

npx add-mcp https://doc.x-lf.com/api/mcp

常用管理命令

# 查看已安装的 MCP 服务列表
claude mcp list

# 移除竹简文档服务
claude mcp remove bamboo-document

可用 MCP 工具

工具名功能参数
sector获取所有可用的文档板块列表
list查看指定板块的文档目录列表sector(必填)、search(可选关键词)
detail获取指定文档的完整内容sector(板块标识)、path(文档路径)
search在文档内容中搜索关键词query(必填)、sector(可选)、path(可选)

可用板块

当前支持的文档板块:

  • bamboo-base-go - Go 语言基础框架文档
  • bamboo-base-java - Java 语言基础框架文档
  • guide - 使用指南

查看完整板块列表

使用 sector 工具可随时获取最新的板块列表,新板块会持续添加。

使用示例

在 Claude Code 中,直接提问即可。Claude 会自动调用 MCP 工具获取相关文档内容:

帮我查一下 bamboo-base-go 的快速开始指南
搜索 bamboo-base-java 中的业务异常处理方式

最佳实践

让 Claude 知道你在使用哪个板块(如 bamboo-base-go),可以获得更精准的文档匹配结果。

相关链接

On this page