Onx Mcp Server

by StevanFreeborn

310 downloads

Not rated

GitHub

Other

About

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.

Details

Author: StevanFreeborn
Downloads: 310
Categories: Other

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name Onx Mcp Server

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

From the repository

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.

`check-onspring-connection`

Checks if you can connect to the Onspring instance

`get-apps`

Retrieves a list of apps from the Onspring instance

`get-fields`

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

`get-records`

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

`get-reports`

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

`get-report-data`

Retrieves the data for a specific report from the Onspring instance

`query-records`

Queries records from a specific app in the Onspring instance

`get-file`

Retrieves a file from a specific record in the Onspring instance

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "onx mcp server": {
            "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"
                }
            }
        }
    }
}

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

Onspring 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.

Description

This server provides a bridge between AI assistants and Onspring instances through the Model Context Protocol. It enables MCP clients to read and interact with your Onspring data, providing capabilities like:

- Retrieving lists of apps and their fields
- Fetching records from apps
- Running queries against apps
- Accessing report data
- Retrieve files from attachment fields

- 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 @stevanfreeborn/onx-mcp-server

Or use it directly via npx:

npx @stevanfreeborn/onx-mcp-server

Building from Source

If you want 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

In order to use the server, you will need to configure it in the MCP client of your choice. Each MCP client should provide instructions on setting up a MCP server. You will also need to make sure the required environment variables are set. See the Configuration section for more details.

Configuration

The server requires that the following environment variables are set:

| Variable | Description | Default |
| ------------------- | --------------------------------- | -------------------------- |
| ONSPRING_API_KEY | Your Onspring API key | (Required) |
| ONSPRING_BASE_URL | The base URL for the Onspring API | <https://api.onspring.com> |

Connecting to Claude Desktop

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

1. Find the claude_desktop_config.json file. Please reference this documentation for more information on where to find this file: For Claude Desktop Users.

2. Open the claude_desktop_config.json file in a text editor and add the following configuration:

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

> [!NOTE]
> The specific command and arguments may vary based on your setup.

Available Tools

The MCP Server exposes the following tools for AI assistants to interact with Onspring:

checkConnectionTool

Verifies that the server can connect to the Onspring API using the provided credentials.

getAppsTool

Retrieves a list of all accessible apps in the Onspring instance.

getFieldsTool

Gets all fields for a specified app.

Parameters:

- name: The name of the app

getRecordsTool

Retrieves records from an app with specified fields.

Parameters:

- appName: The name of the app
- fields: Array of field names to retrieve
- pageNumber: The page number to start from (1-based)
- numberOfPages: The number of pages to retrieve

getReportsTool

Gets all reports available for a specified app.

Parameters:

- appName: The name of the app

getReportDataTool

Retrieves data from a specified report.

Parameters:

- appName: The name of the app
- reportName: The name of the report
- dataType: The type of report data to retrieve (optional)

queryRecordsTool

Queries records from an app using a filter.

Parameters:

- appName: The name of the app
- fields: Array of field names to retrieve
- filter: A filter object to restrict the results
- pageNumber: The page number to start from (1-based)
- numberOfPages: The number of pages to retrieve

getFileTool

Retrieves a file stored in an attachment field.

Parameters:

- appName: The name of the app
- fieldName: The name of the attachment field
- recordId: The ID of the record containing the file
- fileName: The name of the file to retrieve

Development

Setup Development Environment

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

Testing

The project uses Vitest for testing:

# Run tests
npm test
Run tests with coverage
npm run test:coverage
Run tests with UI
npm run test:ui

Inspecting the Server

You can use the MCP Inspector to test the server:

npm run inspect

License

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

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

check-onspring-connection

get-apps

get-fields

get-records

get-reports

get-report-data

query-records

get-file

Claude Desktop / Cursor

McpServers

Onspring MCP Server

Description

Table of Contents

Installation

Prerequisites

Installation Steps

Building from Source

Install dependencies

Build the project

Start the server

Usage

Configuration

Connecting to Claude Desktop

Available Tools

checkConnectionTool

getAppsTool

getFieldsTool

getRecordsTool

getReportsTool

getReportDataTool

queryRecordsTool

getFileTool

Development

Setup Development Environment

Run in development mode (watches for changes)

Testing

Run tests with coverage

Run tests with UI

Inspecting the Server

License

Install

More like this

Sequential Thinking

Filesystem

EverArt

Google Drive

Reactive Resume

FastMCP v2 🚀

`check-onspring-connection`

`get-apps`

`get-fields`

`get-records`

`get-reports`

`get-report-data`

`query-records`

`get-file`