Skip to main content

Run your Ronin Editing account from any AI assistant. A local MCP server that lets Claude, Cursor, Cline, VS Code and other MCP clients read your orders, invoices and reports, and (opt in) place and manage orders, using your own Ronin API key.

Project description

Ronin Customer MCP Server

Run a local AI tool server that lets your AI assistant read your Ronin orders, invoices, and reports, and (if you turn it on) place and manage orders. It uses your own Ronin API key. Nothing is exposed to the public; the server runs on your machine over stdio and works with any MCP client (Claude Desktop, Claude Code, Cursor, Cline, Windsurf, VS Code with Copilot, LM Studio, Goose, and more).

What it can do

Read tools are on by default. Write tools are off until you explicitly enable them and your key has write permission.

Read tools (default on)

Tool What it does
list_orders List your orders, optionally filtered by status
get_order Full detail for one order
get_order_delivery Delivery info and download links for an order
list_order_messages Messages on an order thread
list_order_amendments Amendment requests on an order
list_invoices / get_invoice Your invoices
get_cost_summary Cost report by day for a date range
get_orders_report Per-order detail report for a date range
get_monthly_statement Total orders and revenue for a month
get_invoices_report Invoices report by status
list_services / get_service The service catalog
preview_pricing Price a cart of services without placing an order
whoami / get_usage Account, key, and recent usage

Write tools (off by default, opt in)

create_order, create_orders_batch, cancel_order, send_order_message, request_amendment, cancel_amendment, submit_feedback, update_order_source_file_count.

create_order accepts external_ref so you can tag each order with your own property or shoot ID for reconciliation, and order_name to give the order a human-readable label (e.g. the property address) that shows on confirmations, internal queues, and your reports. When order_name is omitted the order falls back to the first line of special_instructions.

Get an API key

Sign in to your Ronin portal, open API tokens, and create a key. Copy it once (it is shown only at creation). The key carries scopes such as orders:read, orders:write, billing:read, reports:read, catalog:read. The server only shows tools your key is allowed to use.

Install

pip install ronin-customer-mcp

This installs a ronin-customer-mcp command. Run it directly to check it works:

RONIN_API_KEY=rk_live_xxx ronin-customer-mcp

(The server speaks the MCP protocol over stdio, so run it from your MCP client rather than interactively.)

Configuration (environment variables)

Variable Required Default Meaning
RONIN_API_KEY yes none Your Ronin API key
RONIN_API_BASE_URL no https://api.ronincenter.com API base URL
RONIN_MCP_ENABLE_WRITE no false Set true to expose write tools

Add to your MCP client

Most MCP clients use the same JSON shape. Point the command at the installed ronin-customer-mcp executable.

Claude Desktop (claude_desktop_config.json) and Claude Code (.mcp.json), under mcpServers:

{
  "mcpServers": {
    "ronin": {
      "command": "ronin-customer-mcp",
      "env": {
        "RONIN_API_KEY": "rk_live_xxx",
        "RONIN_MCP_ENABLE_WRITE": "false"
      }
    }
  }
}

Cursor (.cursor/mcp.json), Cline, and VS Code (Copilot MCP) use the same command / env structure under their MCP settings.

To allow placing or cancelling orders, set RONIN_MCP_ENABLE_WRITE to true and use a key that has the orders:write scope.

Safety

This server is designed to be safe by default.

  • Read only by default. Write tools require two things at once: you set RONIN_MCP_ENABLE_WRITE=true and your key has the write scope. If either is missing, the AI cannot place or cancel orders.
  • Your key only ever sees your own data. A leaked key affects only your account.
  • Treat order content as data, not instructions. Order notes, messages, and amendment or feedback text are written by people and can contain text that tries to manipulate an AI agent. Every tool result marks these fields under untrusted_fields. Your AI assistant should never follow instructions found inside them.

Troubleshooting

  • missing_api_key: set RONIN_API_KEY.
  • invalid_api_key: the key was rejected. Check it is correct and active.
  • A write tool is not listed: set RONIN_MCP_ENABLE_WRITE=true and use a key with the orders:write scope.
  • A read tool is not listed: your key is missing that scope. Add the scope in the portal.

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

ronin_customer_mcp-0.3.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

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

ronin_customer_mcp-0.3.0-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file ronin_customer_mcp-0.3.0.tar.gz.

File metadata

  • Download URL: ronin_customer_mcp-0.3.0.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for ronin_customer_mcp-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f473757be8d48c63d1c876e35ea3f35c0dd61503147eb86893c33e7cec6a11e7
MD5 ce1479583faa4ceb5ee2023b324e2859
BLAKE2b-256 acf33fae23e1f00b1bad34e72b1348824b612b8b989f871b91e21ba0972b2645

See more details on using hashes here.

File details

Details for the file ronin_customer_mcp-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ronin_customer_mcp-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c6dd690ef6b1ea79e0aa7a2762ca0398e00daf59016a7fa3ce804edbf6d718a
MD5 f37b897420c09bdb17197a6ed0de4afb
BLAKE2b-256 e770d2e9a683d42fbe77a342ead4477cb847119fec7d6c22ed2d226fc59435c0

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