项目简介

本项目是一个基于 FastMCP 框架构建的 MCP (Model Context Protocol) 服务器，旨在演示如何将 Clever Cloud 的文档和相关服务以标准化的 MCP 协议形式提供给 LLM 客户端。通过该服务器，LLM 应用可以方便地访问 Clever Cloud 的文档资源，并调用预设的工具来获取 Clever Cloud 的相关信息。

主要功能点

资源访问: 提供对 Clever Cloud 文档的访问能力，例如以 Markdown 格式读取文档内容。
工具调用: 集成多个实用工具，允许 LLM 客户端调用以获取 Clever Cloud 的实时信息，例如：
- 获取 Clever Cloud 部署区域列表
- 获取 Clever Cloud 文档 URL 列表
- 获取指定 URL 网页的 Markdown 内容
Prompt 模板: 定义了简单的 Prompt 模板，可以根据需求定制与 LLM 的交互方式 (虽然示例 Prompt 较为简单，但框架支持更复杂的 Prompt 模板定义)。

安装步骤

克隆仓库:

git clone https://github.com/LostInBrittany/clever-doc-mcp-server.git
cd clever-doc-mcp-server

安装依赖: 确保你已安装 Node.js 和 npm。在项目根目录下运行：
```
npm install
```
构建项目:
```
npm run build
```

服务器配置

要让 MCP 客户端（例如 Claude Desktop）连接到此 MCP 服务器，你需要提供服务器的启动配置。以下是一个 JSON 格式的配置示例，可以直接复制到 MCP 客户端的配置中：

{
  "clever-cloud-doc-server": {  //  服务器名称，可以自定义，用于在客户端中标识
    "command": "npx",         //  启动服务器的命令，这里使用 npx
    "args": [                 //  传递给命令的参数
      "-y",                   //  npx 参数，自动确认执行
      "clever-doc-mcp-server" //  要执行的 npm 包名，这里假设你已将项目打包并可通过 npx 运行
    ]
  }
}

注意:

上述配置假设你已经将项目打包，并且可以通过 'npx clever-doc-mcp-server' 命令运行服务器。
实际部署时，你可能需要根据你的环境调整 'command' 和 'args'。例如，如果直接运行编译后的 'index.js' 文件，配置可能如下：

{
  "clever-cloud-doc-server": {
    "command": "node",
    "args": [
      "./dist/index.js"  //  指向编译后的服务器入口文件
    ]
  }
}

请根据你的实际部署情况选择合适的配置。

基本使用方法

启动 MCP 服务器: 根据你的配置，使用 'npx clever-doc-mcp-server' 或 'node dist/index.js' 命令启动服务器。服务器默认使用 'stdio' 传输协议，并在终端输出日志信息。
配置 MCP 客户端: 将上述提供的 JSON 配置添加到你的 MCP 客户端配置中，确保服务器名称 ('clever-cloud-doc-server') 与配置一致。
在 MCP 客户端中使用: 客户端连接成功后，你就可以在客户端中：
- 列出和读取资源: 例如，读取名为 "Clever Cloud Documentation" 的资源，获取 Clever Cloud 的文档内容。
- 列出和调用工具: 例如，调用 'get_clever_zones' 工具获取 Clever Cloud 的部署区域列表，或调用 'fetch_webpage_markdown' 工具获取指定网页的 Markdown 内容。
- 使用 Prompt 模板: 获取并使用预定义的 Prompt 模板与 LLM 进行交互（虽然示例 Prompt 较为简单，但你可以根据需要扩展 Prompt 模板的功能）。

通过以上步骤，你就可以体验如何使用 MCP 客户端与此 Clever Cloud 文档 MCP 服务器进行交互，从而理解 MCP 协议在 LLM 应用中如何提供上下文信息和功能。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息