Documentation — AppRamp

01 — QUICKSTARTQuickstart

Three steps separate an OpenAPI document from a working AI integration.

Create a workspace. Sign up with your email — your company name becomes an isolated workspace (for example, acme-inc).
Import your API. On the dashboard, choose New MCP server, paste an OpenAPI 3.x or Swagger 2.0 document (or a URL to one), and select the HTTP methods a model may use.
Call your endpoint. The dashboard shows the generated tools and your endpoint. Any MCP client can use it immediately.

POST https://gateway.appramp.dev/{workspace}/{api}/{env}

{ "jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {} }

02 — IMPORTImporting a specification

The compiler accepts OpenAPI 3.x and Swagger 2.0, as JSON or YAML, pasted directly or fetched from a URL. Every operation that passes the guardrails becomes one MCP tool with typed input and output schemas.

Base URL

If your specification declares a relative server URL (for example servers: [{ "url": "/api/v3" }]), supply the absolute address in the Base URL override field. The import form will tell you when this is required.

Versions

Each import of the same server name creates a new immutable version and moves the active pointer. Previous versions remain stored, so a rollback is a pointer change, not a re-import.

03 — CONNECTConnecting a client

Your endpoint implements the Model Context Protocol over JSON-RPC 2.0. Supported methods:

Method	Purpose
`initialize`	Protocol handshake
`tools/list`	List available tools with schemas
`tools/call`	Execute a tool against your backend
`resources/list`	List UI widgets, when deployed
`resources/read`	Fetch widget markup

Results are always returned as a JSON object. When a tool produces an array or a primitive, the gateway wraps it as { "result": … }, as the MCP specification requires.

04 — GUARDRAILSGuardrails

The compiler is conservative by design:

Only the HTTP methods you allow are compiled — GET alone by default.
Administrative and internal paths (/admin, /internal, /auth, and similar) are excluded.
Deprecated operations and binary uploads are skipped.
Every import returns a report listing each generated tool and each filtered operation with the reason.

05 — USAGE & LIMITSUsage & limits

Every request to your endpoints is counted against your workspace. Your dashboard shows the running monthly total against your plan limit and a fourteen-day daily history. When a workspace exceeds its monthly limit, or is suspended, the gateway declines requests with error -32006 before your backend is contacted.

06 — REFERENCEError codes

Code	Meaning
`-32001`	Specification not found
`-32002`	Tool not found
`-32003`	Input or output validation failed
`-32004`	Backend error (your API returned a failure)
`-32005`	Backend timeout
`-32006`	Request limit reached or account suspended
`-32007`	Resource not found

From specification to live tools.