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.11.3.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.11.3-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: imbi_mcp-2.11.3.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.11.3.tar.gz
Algorithm Hash digest
SHA256 ee75bc73895311cac8fa907945c54a55be610678bdf1a76c435d87b3ad287442
MD5 60195c58acccb215d2e58a6ca7667751
BLAKE2b-256 409cbb474aab23b1cd556b6ce1f0c461f273f797c5b266b5bad2679c2c6e033c

See more details on using hashes here.

Provenance

The following attestation bundles were made for imbi_mcp-2.11.3.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.11.3-py3-none-any.whl.

File metadata

  • Download URL: imbi_mcp-2.11.3-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.11.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1cee1de1e727df05fd682e18c79c7215f8e50b50e71c7fe2be7578bec120a8d0
MD5 2acf774452bb9a7e143630df3617fb86
BLAKE2b-256 4cb50a9f6e2da98654d72d222481f63249619dd6937eaa696d001c1e2bfdab66

See more details on using hashes here.

Provenance

The following attestation bundles were made for imbi_mcp-2.11.3-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