概要
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.
