关键词

LLM上下文服务资源管理工具调用Prompt管理API集成Typescript SDK

使用说明

项目简介

Orq MCP Server 是 '@orq-ai/node' SDK 的一个组件，它不仅是一个用于 orq.ai API 的 Typescript SDK，还能作为一个可安装的 Model Context Protocol (MCP) 服务器运行。该服务器旨在简化 LLM 应用与上下文信息的交互，提供资源管理、工具注册和 Prompt 模板渲染等核心 MCP 功能。

主要功能点

  • 资源管理: 托管和管理各种资源，例如文件、数据集和配置等，为 LLM 应用提供数据访问能力。
  • 工具注册与执行: 将 Orq SDK 的方法作为工具注册到 MCP 服务器，允许 LLM 客户端调用这些工具执行特定操作，例如创建用户联系人、检索文件列表、调用部署模型等。
  • Prompt 模板: 支持 Prompt 模板的定义和管理，但仓库描述中未明确提及 Prompt 模板的注册和渲染功能，可能需要进一步代码分析确认。
  • 标准 MCP 协议: 遵循 Model Context Protocol 标准，通过 JSON-RPC 协议与 MCP 客户端通信。
  • 多种传输协议支持: 支持 Stdio 和 SSE 传输协议，方便集成到不同的 LLM 应用环境。

安装步骤

使用 npm, pnpm, bun 或 yarn 等包管理器安装 '@orq-ai/node' SDK：

npm add @orq-ai/node

或

yarn add @orq-ai/node

服务器配置

为了让 MCP 客户端（如 Claude 或 Cursor）连接到 Orq MCP Server，您需要在客户端的配置文件中添加服务器定义。以下是 Claude 和 Cursor 的配置示例：

  • 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 环境 (可选)
      ]
    }
  }
}
  • 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"  // 替换为您的 Orq API 密钥和可选参数
}

参数注释:

  • 'command': 指定启动 MCP 服务器的命令，这里使用 'npx' 来运行 Node.js 包。
  • 'args': 传递给 'npx' 命令的参数列表：
    • '-y --package @orq-ai/node': 使用 'npx' 安装并运行 '@orq-ai/node' 包。
    • '--': 分隔 'npx' 参数和传递给包的参数。
    • 'mcp start': 指定运行 '@orq-ai/node' 包中的 'mcp' 命令的 'start' 子命令，启动 MCP 服务器。
    • '--api-key YOUR_API_KEY': (必选) 您的 Orq API 密钥，用于服务器鉴权。
    • '--contact-id YOUR_CONTACT_ID': (可选) 您的 Contact ID，用于关联用户上下文。
    • '--environment YOUR_ENVIRONMENT': (可选) 您的 Orq 环境，例如 "staging" 或 "production"。

基本使用方法

  1. 确保已安装 Node.js v20 或更高版本。
  2. 安装 '@orq-ai/node' SDK。
  3. 根据您的 MCP 客户端 (Claude 或 Cursor) 配置 MCP 服务器启动命令和必要的 API 密钥等参数。
  4. 启动 MCP 客户端，客户端将自动连接到 Orq MCP Server。
  5. 在 MCP 客户端中，您可以利用 Orq MCP Server 提供的工具和资源，例如调用 'deployments-invoke' 工具来执行模型部署，或使用 'files-list' 工具来获取文件列表等。具体可用工具和资源请参考仓库文档和工具列表。

关键词 LLM上下文服务, 资源管理, 工具调用, Prompt管理, API集成, Typescript SDK

信息

分类

开发者工具

访问项目