Skip to main content

Declarative MCP server for the Cartograph widget library

Project description

cartograph-mcp

CI PyPI version

An MCP server for Cartograph that exposes the daily widget workflow for agents without mirroring the entire CLI. Search, inspect, install, create, validate, check in, and configure Cartograph defaults through a compact agent-facing surface, then fall back to the CLI for the full administrative and recovery surface.

Why this exists

The Cartograph CLI is the source of truth, but agents do better when the common path is small and explicit.

This MCP keeps the top-level tool surface focused on daily driving:

  • finding reusable widgets
  • inspecting and installing them
  • managing installed widget copies
  • creating new widgets
  • validating and checking them back in
  • adjusting the core Cartograph defaults that affect normal workflow

Everything else stays in the CLI. That keeps the MCP easier to teach, easier to test, and less likely to drift into a second full interface.

Quick start

pip install cartograph-mcp

Claude Desktop example:

{
  "mcpServers": {
    "cartograph": {
      "command": "cartograph-mcp"
    }
  }
}

The package depends on cartograph-cli and shells out to it as the source of truth for the full command surface.

Common CLI setup commands:

# Claude Code
claude mcp add cartograph -- cartograph-mcp

# Codex
codex mcp add cartograph -- cartograph-mcp

# Gemini CLI
gemini mcp add cartograph cartograph-mcp

# Cursor
cursor --add-mcp '{"name":"cartograph","command":"cartograph-mcp"}'

Tool surface

The MCP intentionally exposes a small workflow-oriented surface:

  • registry_widget Actions: search, inspect, install, rate
  • installed_widget Actions: upgrade, uninstall
  • widget_status
  • create_widget
  • validate_widget
  • checkin_widget
  • cartograph_config

These are not a 1:1 mirror of the CLI. They are grouped around agent intent:

  • registry-facing work
  • installed-widget mutation
  • project health/status
  • widget authoring
  • workflow configuration

Example workflow

1. Search the registry before writing logic.
2. Inspect the widget you want to reuse.
3. Install it into the project.
4. If no existing widget fits, create one.
5. Validate it with the full dry-run pipeline.
6. Check it in with a reason once it is ready.

In Cartograph terms:

  • registry_widget handles discovery and install
  • installed_widget handles already-installed widget paths like cg/backend_retry_python
  • validate_widget is the dry run for checkin_widget
  • cartograph_config manages the defaults that change how your day-to-day loop behaves

Philosophy

This MCP is deliberately not the whole CLI.

The common path belongs in MCP. The official full surface belongs in cartograph.

For uncommon, administrative, or recovery operations, use:

cartograph --help
cartograph <command> --help

That includes things like rollback/delete, cloud operations, auth, setup, rules, doctor, export/import, and other non-daily commands.

Configuration

cartograph_config exposes the workflow defaults that matter most to agents:

  • auto-publish
  • visibility
  • governance
  • cloud
  • show-unavailable
  • publish-registry

Reading and writing config is done through the CLI's --json path so MCP can consume it safely.

Testing

This package is tested in two layers:

  • command-contract tests that mock the CLI runner and assert the exact commands the MCP builds
  • isolated integration tests that run the real Cartograph CLI in a temporary environment

The integration suite isolates:

  • HOME
  • XDG_CONFIG_HOME
  • XDG_DATA_HOME
  • XDG_CACHE_HOME
  • WIDGET_LIBRARY_PATH
  • project working directory

That means validate/checkin/install flows are exercised without touching the real widget library or user config on the machine running tests.

Development

pip install -e .
pytest -q

The repo includes:

  • ci.yml for normal test/build validation on pushes and pull requests
  • pypi-publish.yml for automated release publishing after a successful version-bump CI run

For the full product story and complete CLI surface, see Cartograph.

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

cartograph_mcp-0.1.1.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

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

cartograph_mcp-0.1.1-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file cartograph_mcp-0.1.1.tar.gz.

File metadata

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

File hashes

Hashes for cartograph_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 29dc1ac1a3f40b1555ee69668e2429b490a441ca34fe88f0576bf7eaa5665546
MD5 ef4a12bf1b1a00291913a0c6a00b4f63
BLAKE2b-256 de72515c5fcd61d96011eb0172ccd4e9f890afeb606a8f49cc26016d703c4624

See more details on using hashes here.

Provenance

The following attestation bundles were made for cartograph_mcp-0.1.1.tar.gz:

Publisher: pypi-publish.yml on benteigland11/cartograph-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 cartograph_mcp-0.1.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for cartograph_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 18fa53167b09772cc2b3da337b2d8cba5950ff12e84ccb5ac914de63f1884463
MD5 0aec858b5aa58568a01b9e694dfa06b3
BLAKE2b-256 b2abae2764052d0f7686cb8601f523c561ff72bedfff8b3d21a5e48b91609074

See more details on using hashes here.

Provenance

The following attestation bundles were made for cartograph_mcp-0.1.1-py3-none-any.whl:

Publisher: pypi-publish.yml on benteigland11/cartograph-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