acomo

Provides OpenAPI-based API documentation and API call capabilities via an MCP server over stdio.
  • typescript

2

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs
{
  "mcpServers": {
    "progress-all-acomo-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/progress-all/acomo-mcp-server:latest"
      ],
      "env": {
        "ACOMO_API_BASE": "http://localhost:3000",
        "ACOMO_TENANT_ID": "acomo-example",
        "ACOMO_ACCESS_TOKEN": "YOUR_TOKEN",
        "ACOMO_OPENAPI_PATH": "/absolute/path/to/repo/openapi.json",
        "ACOMO_REQUEST_TIMEOUT_MS": "30000"
      }
    }
  }
}

You run an MCP server that exposes OpenAPI-based tooling to work with the acomo API from tools. It operates over a stdio transport, letting you browse API docs, fetch schemas, generate request templates, and perform real API calls when you provide tenant and token credentials. This server streamlines how you discover and invoke the API in your development workflows.

How to use

You connect your MCP client to the acomo MCP Server and use the available tools to explore the API and invoke calls. Typical patterns include listing APIs, inspecting an API operation, inspecting components and schemas, generating a request template, and then calling an API operation with the required parameters. The server handles the OpenAPI-driven interactions, while you supply credentials only for the API call tool.

How to install

Prerequisites: you need Docker for the standard, prebuilt way to run the MCP server, or you can run Node locally if you prefer building from source.

Basic installation with Docker (recommended)

{
  "mcpServers": {
    "acomo": {
      "command": "docker",
      "args": [
        "run", "-i", "--rm",
        "ghcr.io/progress-all/acomo-mcp-server:latest"
      ]
    }
  }
}

OpenAPI-based API call environment (credentials required)

If you want to perform API calls via the call_api tool, you must provide the tenant ID and access token through environment variables.

{
  "mcpServers": {
    "acomo": {
      "command": "docker",
      "args": [
        "run", "-i", "--rm",
        "-e", "ACOMO_TENANT_ID=<tenant-id>",
        "-e", "ACOMO_ACCESS_TOKEN=<access-token>",
        "ghcr.io/progress-all/acomo-mcp-server:latest"
      ]
    }
  }
}

Alternative: clone from GitHub and run locally

If you prefer building from source, follow this flow to run MCP locally with Node.js 18+ (Node 20+ recommended).

git clone https://github.com/progress-all/acomo-mcp-server.git
cd acomo-mcp-server
npm ci
npm run build

OpenAPI-based API call with local Node runtime (example config)

If you run the server from a local Node build, you can provide the OpenAPI path and credentials via environment variables.

{
  "mcpServers": {
    "acomo": {
      "command": "node",
      "args": ["/absolute/path/to/repo/dist/server.js"],
      "env": {
        "ACOMO_OPENAPI_PATH": "/absolute/path/to/repo/openapi.json",
        "ACOMO_TENANT_ID": "<tenant-id>",
        "ACOMO_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

Configuration at a glance

The MCP server relies on environment variables to control access and API routing. The following variables are supported when you run API calls:

Environment variables you may use

  • ACOMO_TENANT_ID: required for API calls. This value is sent as the x-tenant-id header.

  • ACOMO_ACCESS_TOKEN: required for API calls. This value is sent as the Authorization: Bearer header.

  • ACOMO_API_BASE: optional. Defaults to https://acomo.app if not provided.

  • ACOMO_OPENAPI_PATH: optional. Path to the OpenAPI spec to load. If not provided, the image contains a default openapi.json.

  • ACOMO_REQUEST_TIMEOUT_MS: optional. Request timeout in milliseconds. Default is 30000.

Available tools

health

Performs a health check of the MCP server to ensure it is responsive.

list_apis

Returns the list of APIs described by the OpenAPI specification.

describe_api

Provides detailed information for a specific operationId, including method, path, summary, and URL samples.

api_schemas

Presents excerpts from parameters, requestBody, and responses for API operations.

generate_request_template

Generates skeletons for pathParams, query, and body based on the API schema.

list_components

Lists available schemas under components.schemas.

describe_component

Shows the JSON Schema for a specified component.

call_api

Executes an API operation by operationId, accepting pathParams, query, and body as needed.

Built by
VeilStrat
AI signals for GTM teams
© 2026 VeilStrat. All rights reserved.All systems operational