Skip to main content

A model context protocol server for interacting with Unblu deployments.

Project description

unblu-mcp

ci documentation pypi version python versions license FastMCP

A Model Context Protocol (MCP) server for debugging and operating Unblu deployments. Optimised for debugging workflows — curated typed tools for common operations, plus an escape hatch for the full 300+ endpoint API.

📚 Full Documentation

Design

The server exposes three layers, each progressively more powerful:

Layer What it is When to use
Curated tools Typed, token-efficient tools for common debugging tasks 90% of debugging sessions
execute_operation Generic escape hatch for any of 331 Unblu API operations When a curated tool doesn't exist
Resources Read-only api:// URIs for browsing the API surface Discovery and schema inspection

Quick Start

Installation

uvx unblu-mcp

Or install persistently: uv tool install unblu-mcp

MCP Client Configuration

Direct API access with an API key:

{
  "mcpServers": {
    "unblu": {
      "command": "uvx",
      "args": ["unblu-mcp"],
      "env": {
        "UNBLU_BASE_URL": "https://your-instance.unblu.cloud/app/rest/v4",
        "UNBLU_API_KEY": "your-api-key"
      }
    }
  }
}

Kubernetes port-forward (auto-managed):

{
  "mcpServers": {
    "unblu": {
      "command": "uvx",
      "args": ["unblu-mcp", "--provider", "k8s", "--environment", "dev"],
      "env": {
        "PATH": "/Users/YOUR_USERNAME/.local/bin:/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin"
      }
    }
  }
}

Tools

Curated tools (read-only)

Tool Description
get_current_account Current account info — good first call to verify connectivity
search_conversations(status?, topic?, assignee_id?, limit?, fields?) Search conversations with filters
get_conversation(conversation_id) Full conversation detail with participants
search_persons(query?, email?, limit?, fields?) Find persons (visitors, agents)
get_person(person_id) Full person detail
get_persons(identifiers, fields?) Batch-resolve up to 20 persons in parallel
search_users(query?, email?, limit?, fields?) Find registered users
get_user(user_id) Full user detail
check_agent_availability(named_area_id?) Check agent availability per named area
search_named_areas(query?, limit?) List named areas (routing targets)
find_operation(query, service?, include_schema?, limit?) Discover API operations by keyword

Mutation tools

Tool Description
assign_conversation(conversation_id, agent_id) Assign a conversation to an agent
end_conversation(conversation_id) End an active conversation

Escape hatch

Tool Description
execute_operation(operation_id, path_params?, query_params?, body?, fields?, confirm_destructive?) Execute any of the 331 Unblu API operations

Resources

URI Description
api://services JSON list of all API service groups
api://operations/{operation_id} Full resolved schema for a specific operation

Prompts

Prompt Description
debug_conversation(conversation_id) Step-by-step debugging workflow for a conversation
find_agent(criteria) Locate an agent and check their availability
account_health_check Validate account configuration and connectivity

Safety

By default, execute_operation blocks DELETE operations unless confirm_destructive=True is passed. For stricter control, install the optional Eunomia policy engine:

uv tool install "unblu-mcp[safety]"

Then point to a policy file:

{
  "mcpServers": {
    "unblu": {
      "command": "unblu-mcp",
      "args": ["--policy", "config/mcp_policies.json"],
      "env": { "UNBLU_BASE_URL": "...", "UNBLU_API_KEY": "..." }
    }
  }
}

The bundled config/mcp_policies.json allows all read-only and curated tools while blocking destructive execute_operation calls by operation ID pattern.

Development

git clone https://github.com/detailobsessed/unblu-mcp.git
cd unblu-mcp
uv sync --all-extras --dev
uv run poe test

License

ISC License

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

unblu_mcp-0.8.2.tar.gz (32.6 kB view details)

Uploaded Source

Built Distribution

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

unblu_mcp-0.8.2-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

Details for the file unblu_mcp-0.8.2.tar.gz.

File metadata

  • Download URL: unblu_mcp-0.8.2.tar.gz
  • Upload date:
  • Size: 32.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for unblu_mcp-0.8.2.tar.gz
Algorithm Hash digest
SHA256 bf34f6b945b5327a5cc6caa0624e68abe3ada1440f3172f6f09206f3fc91f08e
MD5 d9280e6498e51fca132de378eb3d8cae
BLAKE2b-256 cc44c3a7396c48f6733fb3a1e0c5c7d7ca0252d9ec5dd2fb076e26cbfe3635e8

See more details on using hashes here.

File details

Details for the file unblu_mcp-0.8.2-py3-none-any.whl.

File metadata

  • Download URL: unblu_mcp-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 34.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for unblu_mcp-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 63862af020ca7fcaf3269bc2fa6685414406de190ead1824bf7d03cf3d32d9e6
MD5 b9d32913e8b020aeeeb10669ab47d5a0
BLAKE2b-256 c75c93db038c7d1c2863e5cd574a1017644ac53db4a362911c28185c2f1fe7a6

See more details on using hashes here.

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