Onx Mcp Server

Name: Onx Mcp Server
Author: StevanFreeborn

@StevanFreeborn

关于 Onx Mcp Server

A Model Context Protocol (MCP) server implementation that integrates with Onspring's API, allowing AI assistants to access and manipulate data stored in Onspring instances.

#onspring #mcp #mcp-server

基本信息

分类

其他

许可证

MIT license

运行时

node

传输方式

stdio

发布者

StevanFreeborn

提交者

Stevan Freeborn

配置

使用下面的配置,将此服务器添加到你的 MCP 客户端。

{
  "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"
      }
    }
  }
}

工具

Checks if you can connect to the Onspring instance

Retrieves a list of apps from the Onspring instance

Retrieves a list of fields from the Onspring instance for a particular app

Retrieves a list of records from an app or survey in the Onspring instance

Retrieves a list of reports from the Onspring instance for a particular app

Retrieves the data for a specific report from the Onspring instance

Queries records from a specific app in the Onspring instance

Retrieves a file from a specific record in the Onspring instance

概览

What is Onx Mcp Server?

Onx Mcp Server is a Model Context Protocol (MCP) server that integrates with the Onspring API. It allows AI assistants to read and interact with data stored in Onspring instances, including retrieving apps, fields, records, reports, and files.

How to use Onx Mcp Server?

Install the package globally (npm install -g @stevanfreeborn/onx-mcp-server) or use via npx. Set the required environment variables ONSPRING_API_KEY and ONSPRING_BASE_URL, then configure the server in your MCP client (e.g., Claude Desktop) with the appropriate command and arguments.

Key features of Onx Mcp Server

Retrieve lists of apps and their fields
Fetch records from apps
Query apps using filters
Run reports and access report data
Retrieve files from attachment fields
Verify API connection with a check tool

Use cases of Onx Mcp Server

An AI assistant lists all apps in an Onspring instance
Query records from a specific app with custom filters
Fetch report data from an Onspring report
Extract files stored in attachment fields
Validate connectivity to the Onspring API

FAQ from Onx Mcp Server

What are the prerequisites for using Onx Mcp Server?

You need Node.js, an Onspring instance with API access, and an Onspring API key with appropriate permissions.

How do I configure Onx Mcp Server?

Set the environment variables ONSPRING_API_KEY (your API key) and ONSPRING_BASE_URL (defaults to https://api.onspring.com). Then add the server configuration to your MCP client’s config file.

What tools does Onx Mcp Server expose?

It provides checkConnectionTool, getAppsTool, getFieldsTool, getRecordsTool, getReportsTool, getReportDataTool, queryRecordsTool, and getFileTool.

How can I connect Onx Mcp Server to Claude Desktop?

Edit claude_desktop_config.json to include an entry for onx-mcp-server with command npx, arguments ["-y", "@stevanfreeborn/onx-mcp-server"], and the required environment variables.

Is there a way to test the server locally?

Yes. Clone the repository, install dependencies, build the project, and run npm start or use npm run dev for development mode. You can also use the MCP Inspector via npm run inspect.