Onx Mcp Server

Onspring MCP 服务

一种模型上下文协议（MCP）服务实现，可与 Onspring API 集成，让 AI 助手能够访问和操作存储在 Onspring 实例中的数据。

描述

此服务通过模型上下文协议，为 AI 助手与 Onspring 实例搭建桥梁。它使 MCP 客户端能够读取和交互您的 Onspring 数据，并提供以下功能：

• 获取应用列表及其字段
• 获取应用中的记录
• 对应用运行查询
• 访问报表数据
• 从附件字段中获取文件

目录

• 安装
• 使用方法
• 配置
• 可用工具
• 开发
• 许可证

安装

前提条件

• Node.js
• 可访问 API 的 Onspring 实例
• 具有相应权限的 Onspring API 密钥

安装步骤

1. 全局安装此软件包：

npm install -g @stevanfreeborn/onx-mcp-server

或者通过 npx 直接使用：

npx @stevanfreeborn/onx-mcp-server

从源代码构建

如果要从源代码构建：

# Clone the repository
git clone https://github.com/your-username/onx-mcp-server.git
cd onx-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

# Start the server
npm start

使用方法

要使用此服务，您需要在选定的 MCP 客户端中进行配置。每个 MCP 客户端都应提供设置 MCP 服务的说明。您还需要确保已设置所需的环境变量。有关详情，请参阅配置部分。

配置

此服务要求设置以下环境变量：

变量	描述	默认值
ONSPRING_API_KEY	您的 Onspring API 密钥	（必填）
ONSPRING_BASE_URL	Onspring API 的基础 URL	https://api.onspring.com

连接到 Claude Desktop

Claude Desktop 是一款常用的 MCP 客户端。要将 Onspring MCP 服务连接到 Claude Desktop，请按以下步骤操作：

1. 找到 claude_desktop_config.json 文件。有关该文件位置的详情，请参阅此文档：Claude Desktop 用户指南。

2. 在文本编辑器中打开 claude_desktop_config.json 文件，并添加以下配置：

{
  "mcpServers": {
    "onx-mcp-server": {
      "command": "npx",
      "args": ["-y", "@stevanfreeborn/onx-mcp-server"],
      "env": {
        "ONSPRING_API_KEY": "your_onspring_api_key",
        "ONSPRING_BASE_URL": "https://api.onspring.com"
      }
    }
  }
}

说明

具体命令和参数可能因您的设置而异。

可用工具

MCP 服务提供以下工具，供 AI 助手与 Onspring 交互：

checkConnectionTool

使用提供的凭据验证服务是否能够连接到 Onspring API。

getAppsTool

获取 Onspring 实例中所有可访问应用的列表。

getFieldsTool

获取指定应用的所有字段。

参数：

• name：应用名称

getRecordsTool

获取应用中指定字段的记录。

参数：

• appName：应用名称
• fields：要获取的字段名称数组
• pageNumber：起始页码（从 1 开始）
• numberOfPages：要获取的页数

getReportsTool

获取指定应用的所有可用报表。

参数：

• appName：应用名称

getReportDataTool

获取指定报表的数据。

参数：

• appName：应用名称
• reportName：报表名称
• dataType：要获取的报表数据类型（可选）

queryRecordsTool

使用筛选条件查询应用中的记录。

参数：

• appName：应用名称
• fields：要获取的字段名称数组
• filter：用于限制结果的筛选对象
• pageNumber：起始页码（从 1 开始）
• numberOfPages：要获取的页数

getFileTool

获取存储在附件字段中的文件。

参数：

• appName：应用的名称
• fieldName：附件字段的名称
• recordId：包含该文件的记录 ID
• fileName：要获取的文件名称

开发

设置开发环境

# Install dependencies
npm install

# Run in development mode (watches for changes)
npm run dev

测试

项目使用 Vitest 进行测试：

# Run tests
npm test

# Run tests with coverage
npm run test:coverage

# Run tests with UI
npm run test:ui

检查服务

你可以使用 MCP Inspector 测试服务：

npm run inspect

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE.md 文件。