Skip to main content

Imbi MCP server

Project description

imbi-mcp

MCP server for the Imbi DevOps service management platform. Exposes Imbi API functionality to AI agents via the Model Context Protocol.

How It Works

At startup the server fetches the OpenAPI spec from a running imbi-api instance and auto-generates MCP tools, resources, and resource templates using FastMCP.

Route mapping rules control what gets exposed:

  • Excluded -- Auth, MFA, status, and thumbnail endpoints are hidden.
  • Resources -- GET endpoints that return collections.
  • Resource templates -- GET endpoints with path parameters.
  • Tools -- Everything else (create, update, delete operations).

The caller's Authorization header is forwarded to the API so that requests run with the caller's permissions.

Authentication

Two modes, which can be used together:

  • Token (always on). The caller's Authorization header — an Imbi ik_ API key or a JWT — is forwarded to the API, which authorizes the request. This works with no extra configuration.
  • OAuth (when configured). Set --public-url and --auth-server-url (see below) to make the server an OAuth 2.0 Resource Server. It then verifies JWT access tokens locally, accepts-and-forwards ik_ API keys, and publishes Protected Resource Metadata so MCP clients can discover the Imbi authorization server and run a browser login flow (authorization-code + PKCE, with Dynamic Client Registration). Local JWT verification uses the shared IMBI_AUTH_JWT_SECRET.

Requirements

  • Python 3.12+
  • A running imbi-api instance

Quick Start

# Install dependencies
just setup

# Run the server (imbi-api must be reachable)
just serve

# Or with explicit options
imbi-mcp serve --api-url http://localhost:8000 --transport streamable-http

CLI Options

imbi-mcp serve [OPTIONS]
Option Default Env Var Description
--api-url http://localhost:8000 IMBI_INTERNAL_API_URL Base URL of the Imbi API
--transport streamable-http MCP transport type
--host 127.0.0.1 Host to bind to
--port 8001 Port to bind to
--public-url (none) IMBI_MCP_PUBLIC_URL Public URL of this server (e.g. https://host/mcp); enables OAuth with --auth-server-url
--auth-server-url (none) IMBI_MCP_AUTH_SERVER_URL Imbi OAuth issuer URL (e.g. https://host); enables OAuth with --public-url

Supported transports: stdio, http, sse, streamable-http

Docker

docker build -t imbi-mcp .
docker run -p 8001:8001 -e IMBI_INTERNAL_API_URL=http://imbi-api:8000 imbi-mcp

Development

just setup       # Install deps and pre-commit hooks
just test        # Run tests (90% coverage minimum)
just lint        # Run ruff, basedpyright, mypy
just format      # Auto-format code

License

BSD-3-Clause

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imbi_mcp-2.9.1.tar.gz (67.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

imbi_mcp-2.9.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file imbi_mcp-2.9.1.tar.gz.

File metadata

  • Download URL: imbi_mcp-2.9.1.tar.gz
  • Upload date:
  • Size: 67.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for imbi_mcp-2.9.1.tar.gz
Algorithm Hash digest
SHA256 b74020a8f596e02f6bb0afb85d17803bb4f0ea538cec598e4c0fa6836132b4a2
MD5 ecf0273b0e21fdd3bb6463ecff09ba66
BLAKE2b-256 233a80ab65bbc54e41dc6b4038c1259fb4c17c90c7a6cadaecec65d0a35d673b

See more details on using hashes here.

Provenance

The following attestation bundles were made for imbi_mcp-2.9.1.tar.gz:

Publisher: publish.yml on AWeber-Imbi/imbi-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file imbi_mcp-2.9.1-py3-none-any.whl.

File metadata

  • Download URL: imbi_mcp-2.9.1-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for imbi_mcp-2.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7c1b05bb1e6549d84fc697c9d3a978f32897733ae63bb1b997aca299cf5b977e
MD5 21b64b0df219d8ebc679ac2b3f7fae46
BLAKE2b-256 c9532db370225b9b616c586f748362b2f5852793c8a7a5debbab046cd2888f55

See more details on using hashes here.

Provenance

The following attestation bundles were made for imbi_mcp-2.9.1-py3-none-any.whl:

Publisher: publish.yml on AWeber-Imbi/imbi-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page