anyapi-mcp-server 1.1.4 → 1.2.1

package/README.md

@@ -16,7 +16,9 @@ Instead of building a custom MCP server for every API, `anyapi-mcp-server` reads
 - **Retry with backoff** — automatic retries with exponential backoff and jitter for 429/5xx errors, honoring `Retry-After` headers
 - **Multi-format responses** — parses JSON, XML, CSV, and plain text responses automatically
 - **Built-in pagination** — API-level pagination via `params`; client-side slicing with top-level `limit`/`offset`
-- **Per-request headers** — override default headers on individual `call_api`/`query_api` calls
+- **Spec documentation lookup** — `explain_api` returns rich endpoint docs (parameters, response codes, deprecation, request body schema) without making HTTP requests
+- **Concurrent batch queries** — `batch_query` fetches data from up to 10 endpoints in parallel, returning all results in one tool call
+- **Per-request headers** — override default headers on individual `call_api`/`query_api`/`batch_query` calls
 - **Environment variable interpolation** — use `${ENV_VAR}` in base URLs and headers
 - **Request logging** — optional NDJSON request/response log with sensitive header masking
 
@@ -114,10 +116,10 @@ Add to your MCP configuration (e.g. `~/.cursor/mcp.json` or Claude Desktop confi
         "anyapi-mcp-server",
         "--name", "metabase",
         "--base-url", "https://your-metabase-instance.com/api",
-        "--header", "X-Metabase-Session: ${METABASE_SESSION_TOKEN}"
+        "--header", "x-api-key: ${METABASE_API_KEY}"
       ],
       "env": {
-        "METABASE_SESSION_TOKEN": "your-metabase-session-token"
+        "METABASE_API_KEY": "your-metabase-api-key"
       }
     }
   }
@@ -126,7 +128,7 @@ Add to your MCP configuration (e.g. `~/.cursor/mcp.json` or Claude Desktop confi
 
 ## Tools
 
-The server exposes three MCP tools:
+The server exposes five MCP tools:
 
 ### `list_api`
 
@@ -206,11 +208,33 @@ Fetch data from an API endpoint, returning only the fields you select via GraphQ
 - For API-level pagination, pass limit/offset inside `params` instead
 - Accepts optional `headers` to override defaults for this request
 
+### `explain_api`
+
+Get detailed documentation for an endpoint directly from the spec — no HTTP request is made.
+
+- Returns summary, description, operationId, deprecation status, tag
+- Lists all parameters with name, location (`path`/`query`/`header`), required flag, and description
+- Shows request body schema with property types, required fields, and descriptions
+- Lists response status codes with descriptions (e.g. `200 OK`, `404 Not Found`)
+- Includes external docs link when available
+
+### `batch_query`
+
+Fetch data from multiple endpoints concurrently in a single tool call.
+
+- Accepts an array of 1–10 requests, each with `method`, `path`, `params`, `body`, `query`, and optional `headers`
+- All requests execute in parallel via `Promise.allSettled` — one failure does not affect the others
+- Each request follows the `query_api` flow: HTTP fetch → schema inference → GraphQL field selection
+- Returns an array of results: `{ method, path, data }` on success or `{ method, path, error }` on failure
+- Run `call_api` first on each endpoint to discover the schema field names
+
 ## Workflow
 
 1. **Discover** endpoints with `list_api`
-2. **Inspect** a specific endpoint with `call_api` to see its schema and suggested queries
-3. **Query** the endpoint with `query_api` to fetch exactly the fields you need
+2. **Understand** an endpoint with `explain_api` to see its parameters, request body, and response codes
+3. **Inspect** a specific endpoint with `call_api` to see the inferred response schema and suggested queries
+4. **Query** the endpoint with `query_api` to fetch exactly the fields you need
+5. **Batch** multiple queries with `batch_query` when you need data from several endpoints at once
 
 ## How It Works
 
@@ -218,20 +242,21 @@ Fetch data from an API endpoint, returning only the fields you select via GraphQ
 OpenAPI/Postman spec
         │
         ▼
-   ┌─────────┐     ┌──────────┐     ┌────────────┐
-   │ list_api │     │ call_api │────▶│ query_api  │
-   │ (browse) │     │ (schema) │     │ (data)     │
-   └─────────┘     └──────────┘     └────────────┘
-                        │                 │
-                        ▼                 ▼
-                   REST API call     REST API call
-                   (with retry       (cached if same
-                    + caching)        as call_api)
-                        │                 │
-                        ▼                 ▼
-                   Infer GraphQL     Execute GraphQL
-                   schema from       query against
-                   JSON response     response data
+   ┌─────────┐  ┌─────────────┐  ┌──────────┐  ┌───────────┐  ┌─────────────┐
+   │list_api │  │ explain_api │  │ call_api │  │ query_api │  │ batch_query │
+   │(browse) │  │   (docs)    │  │ (schema) │  │  (data)   │  │ (parallel)  │
+   └─────────┘  └─────────────┘  └──────────┘  └───────────┘  └─────────────┘
+        │          │ no HTTP          │               │             │
+        ▼          ▼ request          ▼               ▼             ▼
+   Spec index   Spec index     REST API call    REST API call  N concurrent
+   (tags,       (params,       (with retry      (cached if     REST API calls
+    paths)       responses,     + caching)       same as        + GraphQL
+                 body schema)       │            call_api)      execution
+                                    ▼               │
+                               Infer GraphQL        ▼
+                               schema from     Execute GraphQL
+                               JSON response   query against
+                                               response data
 ```
 
 1. The spec file is parsed at startup into an endpoint index with tags, paths, parameters, and request body schemas

package/build/api-index.js

@@ -144,6 +144,22 @@ export class ApiIndex {
                     description: p.description,
                 }));
                 const requestBodySchema = extractRequestBodySchema(op.requestBody, rawSpec);
+                // Extract response descriptions
+                let responses;
+                if (op.responses) {
+                    responses = Object.entries(op.responses).map(([code, resp]) => ({
+                        statusCode: code,
+                        description: resp.description ?? "",
+                    }));
+                }
+                // Extract request body description
+                let requestBodyDescription;
+                if (op.requestBody && typeof op.requestBody === "object") {
+                    const rb = op.requestBody;
+                    if (typeof rb.description === "string") {
+                        requestBodyDescription = rb.description;
+                    }
+                }
                 const endpoint = {
                     method: method.toUpperCase(),
                     path,
@@ -153,6 +169,13 @@ export class ApiIndex {
                     parameters,
                     hasRequestBody: !!op.requestBody,
                     requestBodySchema,
+                    operationId: op.operationId,
+                    deprecated: op.deprecated ?? undefined,
+                    responses,
+                    requestBodyDescription,
+                    externalDocs: op.externalDocs?.url
+                        ? { url: op.externalDocs.url, description: op.externalDocs.description }
+                        : undefined,
                 };
                 this.addEndpoint(endpoint);
             }

package/build/index.js

@@ -13,7 +13,7 @@ initLogger(config.logPath ?? null);
 const apiIndex = new ApiIndex(config.spec);
 const server = new McpServer({
     name: config.name,
-    version: "1.1.4",
+    version: "1.2.1",
 });
 // --- Tool 1: list_api ---
 server.tool("list_api", `List available ${config.name} API endpoints. ` +
@@ -252,6 +252,159 @@ server.tool("query_api", `Fetch data from a ${config.name} API endpoint, returni
         };
     }
 });
+// --- Tool 4: explain_api ---
+server.tool("explain_api", `Get detailed documentation for a ${config.name} API endpoint from the spec. ` +
+    "Returns all available spec information — summary, description, parameters, " +
+    "request body schema, response codes, deprecation status — without making any HTTP request. " +
+    "Use list_api first to discover endpoints, then explain_api to understand them before calling.", {
+    method: z
+        .enum(["GET", "POST", "PUT", "DELETE", "PATCH"])
+        .describe("HTTP method"),
+    path: z
+        .string()
+        .describe("API path template (e.g. '/api/card/{id}')"),
+}, async ({ method, path }) => {
+    try {
+        const endpoint = apiIndex.getEndpoint(method, path);
+        if (!endpoint) {
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: JSON.stringify({
+                            error: `Endpoint not found: ${method} ${path}`,
+                            hint: "Use list_api to discover available endpoints.",
+                        }),
+                    },
+                ],
+                isError: true,
+            };
+        }
+        const result = {
+            method: endpoint.method,
+            path: endpoint.path,
+            summary: endpoint.summary,
+        };
+        if (endpoint.description) {
+            result.description = endpoint.description;
+        }
+        if (endpoint.operationId) {
+            result.operationId = endpoint.operationId;
+        }
+        if (endpoint.deprecated) {
+            result.deprecated = true;
+        }
+        result.tag = endpoint.tag;
+        if (endpoint.parameters.length > 0) {
+            result.parameters = endpoint.parameters.map((p) => ({
+                name: p.name,
+                in: p.in,
+                required: p.required,
+                ...(p.description ? { description: p.description } : {}),
+            }));
+        }
+        if (endpoint.hasRequestBody) {
+            const bodyInfo = {};
+            if (endpoint.requestBodyDescription) {
+                bodyInfo.description = endpoint.requestBodyDescription;
+            }
+            if (endpoint.requestBodySchema) {
+                bodyInfo.contentType = endpoint.requestBodySchema.contentType;
+                bodyInfo.properties = endpoint.requestBodySchema.properties;
+            }
+            result.requestBody = bodyInfo;
+        }
+        if (endpoint.responses && endpoint.responses.length > 0) {
+            result.responses = endpoint.responses;
+        }
+        if (endpoint.externalDocs) {
+            result.externalDocs = endpoint.externalDocs;
+        }
+        return {
+            content: [
+                { type: "text", text: JSON.stringify(result, null, 2) },
+            ],
+        };
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        return {
+            content: [
+                { type: "text", text: JSON.stringify({ error: message }) },
+            ],
+            isError: true,
+        };
+    }
+});
+// --- Tool 5: batch_query ---
+server.tool("batch_query", `Fetch data from multiple ${config.name} API endpoints concurrently. ` +
+    "Each request in the batch follows the query_api flow — makes a real HTTP request " +
+    "and returns only the fields selected via GraphQL query. " +
+    "All requests execute in parallel; one failure does not affect the others. " +
+    "IMPORTANT: Run call_api first on each endpoint to discover schema field names.", {
+    requests: z
+        .array(z.object({
+        method: z
+            .enum(["GET", "POST", "PUT", "DELETE", "PATCH"])
+            .describe("HTTP method"),
+        path: z.string().describe("API path template"),
+        params: z
+            .record(z.unknown())
+            .optional()
+            .describe("Path and query parameters"),
+        body: z
+            .record(z.unknown())
+            .optional()
+            .describe("Request body for POST/PUT/PATCH"),
+        query: z
+            .string()
+            .describe("GraphQL selection query (use field names from call_api schema)"),
+        headers: z
+            .record(z.string())
+            .optional()
+            .describe("Additional HTTP headers for this request"),
+    }))
+        .min(1)
+        .max(10)
+        .describe("Array of requests to execute concurrently (1-10)"),
+}, async ({ requests }) => {
+    try {
+        const settled = await Promise.allSettled(requests.map(async (req) => {
+            const rawData = await callApi(config, req.method, req.path, req.params, req.body, req.headers, "none");
+            const endpoint = apiIndex.getEndpoint(req.method, req.path);
+            const schema = getOrBuildSchema(rawData, req.method, req.path, endpoint?.requestBodySchema);
+            const queryResult = await executeQuery(schema, rawData, req.query);
+            return { method: req.method, path: req.path, data: queryResult };
+        }));
+        const results = settled.map((outcome, i) => {
+            if (outcome.status === "fulfilled") {
+                return outcome.value;
+            }
+            const message = outcome.reason instanceof Error
+                ? outcome.reason.message
+                : String(outcome.reason);
+            return {
+                method: requests[i].method,
+                path: requests[i].path,
+                error: message,
+            };
+        });
+        return {
+            content: [
+                { type: "text", text: JSON.stringify(results, null, 2) },
+            ],
+        };
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        return {
+            content: [
+                { type: "text", text: JSON.stringify({ error: message }) },
+            ],
+            isError: true,
+        };
+    }
+});
 async function main() {
     const transport = new StdioServerTransport();
     await server.connect(transport);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "anyapi-mcp-server",
-  "version": "1.1.4",
+  "version": "1.2.1",
   "description": "A universal MCP server that connects any REST API (via OpenAPI spec) to AI assistants, with GraphQL-style field selection and automatic schema inference.",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",