Ibm Cloud Docs MCP Server

IBM云文档MCP服务器

一种模型上下文协议（MCP）服务器，为AI客户端提供搜索和检索IBM Cloud文档的能力。此服务器将IBM Cloud的文档作为标准化工具公开，可供LLM和AI应用程序使用。

特性

• 搜索文档：使用分页支持搜索IBM Cloud的广泛文档库
• 阅读文档：检索文档页面并将其转换为干净的Markdown格式
• 清洁API：仅包含基本信息的简化回复
• MCP兼容：适用于任何兼容MCP的客户端（Claude Desktop、带MCP扩展的VSCode等）

安装

bun install

用法

运行MCP服务器

bun run mcp

这将使用stdio传输启动MCP服务器，使其与MCP客户端兼容。

运行演示应用程序

bun run index.ts

这将运行一个独立的演示，搜索Ubuntu VSI文档并将其转换为Markdown。

测试MCP服务器

bun run test-mcp

这将运行一个连接到MCP服务器的测试客户端，并演示这两个工具的实际操作。

MCP工具

search_documentation

在IBM Cloud文档中搜索相关主题和文章。

参数：

• query （string）：IBM Cloud文档的搜索查询
• limit （number，可选）：返回的最大结果数（1-20，默认10）
• offset （number，可选）：分页时要跳过的结果数（默认值0）

退货： 包含搜索结果、总计数和分页信息的JSON对象。

read_documentation

阅读IBM Cloud文档页面并将其转换为干净的Markdown格式。

参数：

• href （字符串）：搜索结果中的文档href（例如，“/docs/containers？topic=容器入门”）

退货： 清理文档页面的Markdown内容。

与Claude Desktop集成

要将此MCP服务器与Claude Desktop一起使用，请将以下内容添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "ibm-cloud-docs": {
      "command": "bun",
      "args": ["--cwd", "/absolute/path/to/this/project", "run", "mcp"]
    }
  }
}

示例用法

1. 搜索文档：

   Search for "kubernetes deployment" with limit 5

1. 阅读具体文档：

   Read documentation from href "/docs/containers?topic=containers-getting-started"

1. 分页搜索：

   Search for "virtual servers" with offset 10 to get the next page

建筑

• mcp-server.ts：主MCP服务器实现
• ibm-cloud-api.ts：用于IBM云文档的API客户端
• utils.ts：URL解析和HTML到Markdown转换的实用函数
• types.ts：TypeScript类型定义

服务器重用健壮的API集成代码，同时通过MCP协议提供干净、简化的接口。

需求

• 包子 运行时
• Node.js 18+（用于MCP SDK兼容性）
• 互联网连接（用于访问IBM Cloud文档API）

许可证

此项目是使用创建的 bun init 在bun v1.2.15中。