使用说明
项目简介
openrouter-docs-server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在演示 MCP 的核心概念。它通过提供工具,使得LLM客户端能够查询 OpenRouter API 的文档和模型列表,从而帮助LLM更好地理解和使用 OpenRouter 提供的各种模型服务。
主要功能点
- 获取模型列表 (get_models): 允许LLM客户端获取 OpenRouter 上可用的模型及其功能列表,返回 JSON 格式的模型信息。
- 获取API文档 (get_api_reference): 允许LLM客户端查询 OpenRouter API 特定端点的参考文档,目前支持 'chat/completions' 和 'models' 两个端点,返回文本格式的API文档。
安装步骤
- 安装依赖: 首先,确保你已经安装了 Node.js 和 npm。然后,在仓库根目录下运行以下命令安装项目依赖:
npm install - 构建服务器: 运行以下命令构建服务器代码:
构建成功后,会在 'build' 目录下生成 'index.js' 文件,这是服务器的入口文件。npm run build
服务器配置
要将此 MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),你需要编辑客户端的配置文件。以 Claude Desktop 为例,你需要修改配置文件 'claude_desktop_config.json'。
配置文件路径:
- macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
配置内容: 在 'claude_desktop_config.json' 文件中,找到或创建 'mcpServers' 字段,并添加以下配置信息。请将 '/path/to/openrouter-docs-server/build/index.js' 替换为 'index.js' 文件的实际路径。
{ "mcpServers": { "openrouter-docs-server": { "command": "/path/to/openrouter-docs-server/build/index.js" } } }
配置参数说明:
- 'openrouter-docs-server': 服务器名称,可以自定义,用于在客户端中标识该服务器。
- 'command': MCP 服务器的启动命令,指向构建后的 'index.js' 文件。请务必替换为实际的绝对路径或相对路径,确保客户端能够找到并执行该文件。 这里假设你将仓库克隆到了 '/path/to/openrouter-docs-server' 目录。
基本使用方法
- 启动服务器: 配置完成后,当 MCP 客户端(如 Claude Desktop)启动时,它会自动尝试连接到配置的 MCP 服务器。此服务器通过 stdio 与客户端通信,无需额外手动启动。
- 在客户端中使用工具: 在支持 MCP 的 LLM 客户端中,LLM 应该能够发现并调用此服务器提供的工具。例如,在 Claude Desktop 中,你可以指示 Claude 使用 'get_models' 工具来获取 OpenRouter 的模型列表,或者使用 'get_api_reference' 工具来查询特定 API 端点的文档。
例如,你可以指示 Claude 执行以下操作:
"请使用 'get_models' 工具查看 OpenRouter 上有哪些模型可用。"
"OpenRouter 的 'chat/completions' API 接口是如何使用的?请使用 'get_api_reference' 工具查询。"
LLM 客户端会将这些指令转换为 MCP 请求发送给 'openrouter-docs-server',服务器会执行相应的工具并返回结果给客户端,最终由 LLM 将结果呈现给你。
信息
分类
开发者工具