Onx MCP Server

🚀 Onspring MCP Server

An implementation of the Model Context Protocol (MCP) server integrated with the Onspring API, enabling AI assistants to access and manipulate data stored in Onspring instances.

🚀 Quick Start

This server serves as a bridge between AI assistants and Onspring instances, offering the following capabilities through the Model Context Protocol:

• Retrieve a list of applications and their fields.
• Fetch records from applications.
• Execute queries on applications.
• Access report data.
• Retrieve files from attachment fields.

📑 Table of Contents

• Installation
• Usage
• Configuration
• Available Tools
• Development
• License

📦 Installation

Prerequisites

• Node.js
• An Onspring instance with API access
• An Onspring API key with appropriate permissions

Installation Steps

1. Install the package globally:

npm install -g onx-mcp-server

Or use npx directly:

npx onx-mcp-server

Build from Source

If you need to build from source:

# 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

💻 Usage

To use this server, you need to configure it in your chosen MCP client. Each MCP client should provide instructions on setting up the MCP server. Also, ensure that the required environment variables are correctly set. Refer to the Configuration section for more details.

⚙️ Configuration

The server requires the following environment variables to be set:

Connect to Claude Desktop

Claude Desktop is a popular MCP client. To connect the Onspring MCP server to Claude Desktop, follow these steps:

1. Locate the claude_desktop_config.json file. Refer to the documentation for Claude Desktop users for more information on finding this file.
2. Open the claude_desktop_config.json file with a text editor and add the following content:

{
  "servers": [
    {
      "url": "http://localhost:3001"
    }
  ]
}

🔧 Development

Set up the Development Environment

# Install dependencies
npm install

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

Testing

The project uses Vitest for testing:

# Run tests
npm test

# Tests with coverage
npm run test:coverage

# Tests with UI
npm run test:ui

Inspect the Server

You can use the MCP monitor to test the server:

npm run inspect

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details.