使用说明
项目简介
本项目 'mcp-clever-demo' 是一个基于 Model Context Protocol (MCP) 的服务器示例,它使用 'mcp-js-server' JavaScript SDK 构建,旨在演示如何将云服务(Clever Cloud)的功能通过 MCP 协议暴露给 LLM 客户端。该服务器提供了一系列工具,允许 LLM 查询 Clever Cloud 的服务信息,例如数据中心区域和开发者文档。
主要功能点
- 提供 Clever Cloud 服务信息查询工具: 通过预定义的工具,LLM 可以获取 Clever Cloud 的可用区域列表、开发者文档 URL 以及指定网页的 Markdown 内容。
- 支持 MCP 协议: 使用 'mcp-js-server' SDK 构建,天然支持 MCP 协议,能够与任何兼容 MCP 协议的客户端进行通信。
- 易于部署和运行: 基于 Node.js 和 npm,可以通过简单的命令快速启动和运行。
安装步骤
由于这是一个可以直接运行的示例项目,因此无需复杂的安装步骤。您只需要确保您的环境中安装了 Node.js 和 npm (或 npx)。
-
确保安装 Node.js 和 npm: 如果您的机器上尚未安装 Node.js 和 npm,请先安装它们。您可以访问 nodejs.org 下载并安装适合您操作系统的版本。通常 npm 会随 Node.js 一起安装。
-
使用 npx 运行 (无需下载仓库): 最简便的方式是直接使用 'npx' 命令运行,无需克隆或下载仓库。'npx' 会自动下载并运行 'mcp-clever-demo' 包。
服务器配置
MCP 客户端需要配置连接到 'mcp-clever-demo' 服务器的命令。以下是 Claude Desktop 或其他 MCP 客户端所需的配置信息 (JSON 格式):
{ "mcp-clever-demo": { "command": "npx", "args": [ "-y", "mcp-clever-demo" ] } }
配置参数说明:
- '"mcp-clever-demo"': 服务器名称,可以自定义,用于在客户端中标识该服务器连接。
- '"command": "npx"': 启动服务器的命令。'npx' 是 npm 包执行器,用于运行 npm 包。
- '"args": [ "-y", "mcp-clever-demo" ]': 传递给 'npx' 命令的参数。
- '"-y"': (可选) 'npx' 的参数,表示自动确认安装 'mcp-clever-demo' 包(如果尚未安装)。
- '"mcp-clever-demo"': 要执行的 npm 包名称,即 'mcp-clever-demo',这将启动仓库中定义的 MCP 服务器。
将以上 JSON 配置添加到您的 MCP 客户端配置中,客户端即可连接到并使用此 MCP 服务器。
基本使用方法
-
启动 MCP 服务器: 按照上述服务器配置,当 MCP 客户端尝试连接 'mcp-clever-demo' 服务器时,客户端会执行 'npx -y mcp-clever-demo' 命令来启动服务器。如果您本地开发,也可以在项目根目录下使用命令 'npx @modelcontextprotocol/inspector npx mcp-clever-demo' 启动服务器并使用 MCP Inspector 进行测试。
-
在 MCP 客户端中使用工具: 一旦客户端成功连接到服务器,您就可以在客户端中调用 'mcp-clever-demo' 服务器提供的工具。例如,在支持工具调用的 LLM 应用中,您可以指示 LLM 使用 'get_clever_zones' 工具来获取 Clever Cloud 的可用区域信息,或使用 'fetch_webpage_markdown' 工具来获取指定网页的内容。
-
使用预定义的 Prompt: 服务器还定义了一些简单的 Prompt 模板,例如 'hello_world'。您可以在客户端中选择并使用这些 Prompt 模板与 LLM 进行交互。
注意: 此示例项目主要用于演示 MCP 服务器的基本功能和 Clever Cloud API 的集成。在实际应用中,您可能需要根据具体需求扩展工具和 Prompt,并考虑更完善的错误处理和安全性措施。
信息
分类
开发者工具