Greenspark

MCP

O servidor Model Context Protocol (MCP) da Greenspark permite que editores de IA (Cursor, Windsurf, VS Code) e ferramentas como Claude Desktop trabalhem com a documentação da API Greenspark e, quando habilitado, chamadas de API ao vivo somente leitura contra sua conta.

O que é MCP?

Model Context Protocol (MCP) é um padrão aberto para conectar aplicativos de IA a ferramentas e dados externos. O servidor MCP da Greenspark (hospedado pela ReadMe) oferece aos agentes:

• Acesso à referência da API — liste e inspecione endpoints, parâmetros e esquemas de resposta
• Contexto da documentação — especificações OpenAPI e guias da Greenspark
• Chamadas ao vivo somente leitura (v1) — execute-request em rotas GET habilitadas quando você fornece uma chave de API válida
• Ajuda de integração — respostas com conhecimento de esquemas e exemplos de solicitações para desenvolver com a Greenspark

Limites da v1: o MCP é somente leitura. As rotas POST, PUT, PATCH e DELETE são documentadas para construção de integrações; use get-endpoint para esquemas, não execute-request para gravações. Billing, Email e Estimations não são expostos por meio das alternâncias de rota do MCP na v1.

Pré-requisitos

1. Uma conta Greenspark com chave de API (crie chaves no painel após o registro).
2. Corresponda a chave ao host: chave de sandbox → https://sandbox.getgreenspark.com; chave de produção → https://api.getgreenspark.com.
3. Para os primeiros testes, use uma chave de sandbox.

A autenticação usa o cabeçalho x-api-key em chamadas de API ao vivo. Alguns clientes MCP permitem anexar cabeçalhos à configuração do servidor MCP; caso contrário, o agente passa a chave ao chamar execute-request.

Servidor MCP da Greenspark

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

Nenhuma senha MCP é necessária para a v1 (deixe em branco nas configurações MCP da ReadMe).

Adicione ao `~/.cursor/mcp.json`:

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

Reinicie o Cursor após salvar. Prefira uma chave de **sandbox** durante os testes.

Adicione às suas configurações MCP do VS Code (extensão Copilot / MCP):

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

Adicione ao `~/.codeium/windsurf/mcp_config.json`:

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

Adicione ao `claude_desktop_config.json`:

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

Observação: Se o seu cliente não suportar cabeçalhos na URL do MCP, conecte-se sem eles e forneça x-api-key quando o agente executar execute-request contra os hosts da Greenspark.

O que você pode fazer na v1

Ferramenta MCP	Finalidade
list-specs / list-endpoints	Navegue pelas especificações e rotas OpenAPI
get-endpoint	Esquema completo para uma operação
search-endpoints	Encontre rotas por palavra-chave
execute-request	Somente GET, em rotas habilitadas nas configurações MCP da ReadMe
get-server-variables	Dicas de ambiente / URL do servidor a partir da especificação

Especificações com exposição MCP na v1: Impact, Reporting, Account, Projects.

Não executáveis por meio das alternâncias MCP da v1: Estimations, Email, Billing (somente documentação).

Algumas rotas exigem planos de assinatura específicos ou tipos de chave; chamadas com falha podem retornar 401, 403 ou 422 (cota de API esgotada).

Kit de instalação do cliente e Agent Skills

O servidor MCP é executado na ReadMe em https://docs.getgreenspark.com/mcp. Para configurações de editor, Agent Skills e metadados de registro, use o repositório público do GitHub:

github.com/getgreenspark/mcp

Recurso	Link
Exemplos de clientes MCP (Cursor, VS Code, Windsurf, Claude Desktop)	examples/
Agent Skills	skills/
Changelog	CHANGELOG.md
Problemas (skills, exemplos, configuração do repositório)	Problemas no GitHub

As Skills são opcionais. Elas ajudam os agentes a usar o MCP da Greenspark corretamente (autenticação, ambientes e fluxos de trabalho GET de domínio). Elas não substituem os esquemas ao vivo de get-endpoint neste site de documentação.

Instalação (exemplo com Cursor):

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