Run-IQ MCP 服务器实现

使用说明(Markdown 格式)

  • 项目简介

    • 这是一个完整的 MCP 服务器实现,能够托管资源、注册并执行 Tools、以及定义与渲染 Prompt 模板。服务器采用插件化架构,可以通过加载插件来扩展模型、规则、输入字段等功能。通过 JSON-RPC 与客户端(如 LLM 客户端)通信,支持多种传输方式,并具备会话管理、能力声明等能力。
  • 主要功能点

    • 资源管理:通过 schema、rules、models 等资源暴露元信息和文档,便于客户端查询和渲染。
    • 工具执行:提供 evaluate、simulate、create_rule、validate_rules、list_models、read/write 资源等工具,支持插件相关字段的动态 schema 验证。
    • Prompts 定义:内置 analyze-text 和 domain-expert 等 prompts,支持插件元数据注入,提升交互能力。
    • 插件化加载:支持从本地目录加载插件和从 NPM 安装加载插件,服务器端会自动整合插件描述符、能力与模型。
    • JSON-RPC 交互:服务器以 MCP 的形式暴露工具、资源、提示等接口,客户端通过 JSON-RPC 请求进行读取、调用和读取资源。
    • 会话与安全:以 dry-run 为默认模式,避免对外部状态的变更,提供参数校验、哈希校验等安全特性。
  • 安装步骤

    • 全局安装并运行:
      • 使用 npm 安装并全局执行,或直接通过 npx 运行
    • 运行前置条件
      • 需要 Node.js 版本 >= 20
    • 插件加载方式
      • 通过 --plugin 指定单个 NPM 插件,或通过 --plugins-dir 指定本地插件目录,或两者结合使用
    • 运行示例(命令行方式,仅作说明)
      • 运行时会从插件中加载模型与描述符,随后公开 MCP 服务端供客户端连接
  • 服务器配置(给 MCP 客户端的连接信息,JSON 格式)

    • 服务器名称(server name):run-iq
    • 启动命令(command):npx
    • 启动参数(args):["@run-iq/mcp-server", "--plugin", "@run-iq/plugin-fiscal"]
    • 说明:这是最常用的基础配置,启动后服务器会自动暴露工具、资源与提示等接口,客户端可通过 MCP 的标准方式连接并发起请求。实际使用中也可通过 --plugins-dir 指定本地插件目录以加载插件集合。

    例子(普通使用场景的单一配置) { "serverName": "run-iq", "command": "npx", "args": ["@run-iq/mcp-server", "--plugin", "@run-iq/plugin-fiscal"] }

  • 基本使用方法

    • 启动服务器后,客户端通过 MCP 提供的工具、资源、提示等接口进行交互(如读取资源、执行工具、获取模型清单等)。
    • 常见操作包括列出模型、创建规则、评估规则、检查规则等,均通过 JSON-RPC 请求完成,返回结构为 JSON。
    • 可以额外加载插件以扩展功能,加载方式可选:直接通过 npm 包名称加载,或从本地目录加载插件包。
  • 重要注意

    • 默认行为是空引擎,需要通过插件注入功能模型与规则。
    • 服务器提供 dry-run 模式,确保不会对外部状态造成持久变更。

服务器信息