Greenspark MCP Server

The Greenspark Model Context Protocol (MCP) server lets AI editors (Cursor, Windsurf, VS Code) and tools like Claude Desktop work with Greenspark API documentation and, where enabled, read-only live API calls against your account.

What is MCP?

Model Context Protocol (MCP) is an open standard for connecting AI apps to external tools and data. The Greenspark MCP server (hosted by ReadMe) gives agents:

• API reference access — list and inspect endpoints, parameters, and response schemas
• Documentation context — Greenspark OpenAPI specs and guides
• Read-only live calls (v1) — execute-request on enabled GET routes when you provide a valid API key
• Integration help — schema-aware answers and example requests for building against Greenspark

v1 limits: MCP is read-only. POST, PUT, PATCH, and DELETE routes are documented for building integrations; use get-endpoint for schemas, not execute-request for writes. Billing, Email, and Estimations are not exposed via MCP route toggles in v1.

Prerequisites

1. A Greenspark account with an API key (create keys in the dashboard after registration).
2. Match key to host: sandbox key → https://sandbox.getgreenspark.com; production key → https://api.getgreenspark.com.
3. For first tests, use a sandbox key.

Authentication uses the x-api-key header on live API calls. Some MCP clients let you attach headers to the MCP server config; otherwise the agent passes the key when calling execute-request.

Greenspark MCP server

URL: https://docs.getgreenspark.com/mcp

No MCP password is required for v1 (leave blank in ReadMe MCP settings).

Add to ~/.cursor/mcp.json:

JSON

{
  "mcpServers": {
    "greenspark": {
      "url": "https://docs.getgreenspark.com/mcp",
      "headers": {
        "x-api-key": "YOUR_SANDBOX_OR_PRODUCTION_API_KEY"
      }
    }
  }
}

Restart Cursor after saving. Prefer a sandbox key while testing.

Note: If your client does not support headers on the MCP URL, connect without them and supply x-api-key when the agent runs execute-request against Greenspark hosts.

What you can do in v1

MCP tool	Purpose
list-specs / list-endpoints	Browse OpenAPI specs and routes
get-endpoint	Full schema for an operation
search-endpoints	Find routes by keyword
execute-request	GET only, on routes enabled in ReadMe MCP settings
get-server-variables	Environment / server URL hints from the spec

Specs with MCP exposure in v1: Impact, Reporting, Account, Projects.

Not executable via MCP v1 toggles: Estimations, Email, Billing (docs only).

Some routes require specific subscription plans or key types; failed calls may return 401, 403, or 422 (API quota exhausted).

Client install kit and Agent Skills

The MCP server runs on ReadMe at https://docs.getgreenspark.com/mcp. For editor configs, Agent Skills, and registry metadata, use the public GitHub repo:

github.com/getgreenspark/mcp

Resource	Link
MCP client examples (Cursor, VS Code, Windsurf, Claude Desktop)	examples/
Agent Skills	skills/
Changelog	CHANGELOG.md
Issues (skills, examples, repo config)	GitHub issues

Skills are optional. They help agents use Greenspark MCP correctly (auth, environments, and domain GET workflows). They do not replace live schemas from get-endpoint on this docs site.

Install (Cursor example):

Bash

npx skills add getgreenspark/mcp -a cursor -g -y

## Testing your setup

1. Connect your editor to `https://docs.getgreenspark.com/mcp` (with sandbox `x-api-key` if supported).
2. Open a new agent chat and confirm the Greenspark MCP tools are listed.
3. Try read-only prompts, for example:
   * "List Greenspark MCP endpoints for Account."
   * "Show the schema for GET public account v2."
   * "Using my sandbox key, call GET /v2/account/ with my account ID" (only if that route is enabled in ReadMe).
4. Confirm **write** operations are not run via MCP — ask for a POST example as code in your app instead.

For machine-readable docs without MCP, see [`https://docs.getgreenspark.com/llms.txt`](https://docs.getgreenspark.com/llms.txt).

Updated 7 days ago

---

Copy Page