使用说明

项目简介

orq-node 仓库不仅提供了一个 Typescript SDK，方便开发者与 orq.ai API 进行交互，更重要的是，它还包含一个可作为 MCP 服务器安装和运行的实现。这个 MCP 服务器可以将 SDK 中提供的各种方法暴露为工具，供 AI 应用（如 Claude、Cursor 等 MCP 客户端）调用，从而扩展 LLM 的能力边界。

主要功能点

资源访问: 通过 SDK 封装的 API 方法，MCP 服务器可以作为数据资源的访问入口，提供如文件列表、Prompt 模板列表等信息。
工具注册与执行: SDK 的各种方法被注册为 MCP 工具，例如 'files_list'、'prompts_create' 等，允许 LLM 客户端调用这些工具来执行特定操作。
Prompt 模板: 虽然仓库描述中没有明确提及 Prompt 模板的托管和渲染，但 'orq-node' SDK 本身包含 prompts 资源的操作，可以推测 MCP 服务器能够间接支持 Prompt 模板的管理和使用。
会话管理和能力声明: MCP 服务器基于 '@modelcontextprotocol/sdk/server/mcp.js' 构建，具备 MCP 服务器的通用会话管理和能力声明功能。
多种传输协议: 支持 Stdio 和 SSE 传输协议，满足不同 LLM 客户端的连接需求。

安装步骤

Node.js 环境: 确保已安装 Node.js v20 或更高版本。
安装 npm 包: 使用 npm 或其他包管理器安装 '@orq-ai/node' 包。
```
npm add @orq-ai/node
```

服务器配置

MCP 服务器需要配置在 MCP 客户端中才能使用。以下分别以 Claude 和 Cursor 为例，提供 MCP 服务器配置信息。

Claude 配置

在 'claude_desktop_config.json' 文件中添加以下服务器定义：

{
  "mcpServers": {
    "Orq": {
      "command": "npx",
      "args": [
        "-y", "--package", "@orq-ai/node",
        "--",
        "mcp", "start",
        "--api-key", "YOUR_API_KEY",  // 替换为您的 Orq API 密钥
        "--contact-id", "YOUR_CONTACT_ID", // 替换为您的 Contact ID (可选)
        "--environment", "YOUR_ENVIRONMENT" // 替换为您的 Orq 环境 (可选)
      ]
    }
  }
}

参数说明:

'command': MCP 服务器的启动命令，这里使用 'npx' 来运行 npm 包的可执行文件。
'args': 启动命令的参数列表，包括：
- '-y': 'npx' 参数，自动确认安装包。
- '--package @orq-ai/node': 'npx' 参数，指定要运行的 npm 包为 '@orq-ai/node'。
- '--': 分隔 'npx' 参数和包的参数。
- 'mcp start': '@orq-ai/node' 包提供的 MCP 服务器启动命令。
- '--api-key YOUR_API_KEY': Orq API 密钥，用于 API 鉴权，请替换为您的真实 API 密钥。
- '--contact-id YOUR_CONTACT_ID': Contact ID，用于关联用户身份 (可选)。
- '--environment YOUR_ENVIRONMENT': Orq 环境，指定运行环境 (可选)。

Cursor 配置

在 Cursor 设置中，进入 'Cursor Settings > Features > MCP Servers > Add new MCP server'，并使用以下配置：

Name: 'Orq' (服务器名称，可自定义)
Type: 'command'
Command:

npx -y --package @orq-ai/node -- mcp start --api-key YOUR_API_KEY --contact-id YOUR_CONTACT_ID --environment YOUR_ENVIRONMENT

参数说明同 Claude 配置。

获取更多参数:

可以通过以下命令查看 MCP 服务器启动命令的完整参数列表：

npx -y --package @orq-ai/node -- mcp start --help

基本使用方法

启动 MCP 服务器: 配置完成后，MCP 服务器会在 MCP 客户端 (如 Claude 或 Cursor) 尝试连接时自动启动。
在 LLM 中调用工具: 在支持 MCP 协议的 LLM 客户端中，您可以指示 LLM 调用由 orq-node MCP 服务器提供的工具，例如：
- 让 Claude 或 Cursor 列出您的文件: 'tool_code files_list'
- 让 Claude 或 Cursor 创建一个新的 Prompt: 'tool_code prompts_create'
具体的工具名称和使用方法，请参考仓库 README.md 中 "Available Resources and Operations" 和 "Standalone functions" 部分的文档链接。

注意:

API 密钥: 请务必将 'YOUR_API_KEY' 替换为您在 orq.ai 平台申请的 API 密钥。
安全性: 注意保护您的 API 密钥，避免泄露。
文档: 更详细的 SDK 和 API 使用方法，请参考 orq.ai Documentation。

关键词