Docs / Agents and API

MCP server

A remote MCP server that gives any MCP client the Volley tools.

On this page

Volley runs a remote Model Context Protocol server at https://volley.sh/mcp. Connect any MCP client to it and your agent can check, describe, render, verify and save diagrams, and read your diagrams and collections as context.

Connect a client

You need an API key.

Claude Code

bash
claude mcp add --transport http volley https://volley.sh/mcp \
  --header "Authorization: Bearer $VOLLEY_KEY"

Clients with a JSON config

Most clients that support remote servers take a URL and headers. In Cursor's mcp.json, for example:

json
{
  "mcpServers": {
    "volley": {
      "url": "https://volley.sh/mcp",
      "headers": { "Authorization": "Bearer volley_..." }
    }
  }
}

Clients that can only start local servers can reach Volley through a bridge such as mcp-remote, passing the same header.

Volley is listed in the MCP Registry as sh.volley/volley.

How it works

  • Transport is Streamable HTTP with JSON responses, protocol version 2025-06-18. The server answers POST only and does not open an event stream.
  • Each request carries one JSON-RPC message.
  • Calling a tool or reading a resource counts as one API call. Listing tools and resources is free. See Usage and limits.
  • The server's instructions include a short primer on the syntax, so the agent can start writing without reading these docs.

Tools

Tools that work on a diagram take either source, the diagram text, or id, the id of one of your saved diagrams.

ToolArgumentsReturns
check_diagramsource or idEach error and warning with line and column, or ok with a count of lanes, messages and payloads
describe_diagramsource or idThe diagram as Markdown: lanes, numbered messages, replies, notes, sections and every payload
render_svgsource or id, theme (light or dark), showPayloadsSVG markup
verify_diagramsource or id, har (the HAR file's text or parsed JSON)A drift check report
list_diagramsquery, limit (up to 100), cursorYour saved diagrams with ids, titles, visibility and links, a page at a time
get_diagramidA saved diagram's title, visibility, short link and full source
save_diagramsource, optional id to update, visibilityThe short link, a README embed and a check summary
list_collectionsqueryYour collections with ids and scenario counts
get_collectionid, fullThe scenarios in a collection, or with full: true the whole collection as Markdown
save_collectiontitle, optional id, description, visibility, entriesThe saved collection. entries replaces the whole list. Pro only.
add_to_collectioncollectionId, diagramId, scenario, noteAdds a diagram to a collection, or updates its entry. Pro only.

save_diagram follows your plan: Free accounts can hold one saved diagram, private diagrams are Pro only, and on Pro, updating a diagram keeps the previous source as a version.

Errors from a tool, such as a missing diagram or a plan limit, come back as a tool result marked as an error, with a message the agent can act on.

Resources

The server exposes your saved work as Markdown resources, so a client can attach them as context:

ResourceContents
volley://collection/{id}The whole collection: introduction, then each scenario with its note and the full description of its diagram
volley://diagram/{id}The diagram's description, its link and its source

Resources include private diagrams and collections, because the key proves they are yours.

Example prompts

  • "Draw the sequence of calls in src/payments/checkout.ts as a Volley diagram with the request and response bodies, check it, and save it."
  • "Read the Volley collection for our billing integration and tell me which scenario covers a partial refund."
  • "Verify docs/checkout.volley against test-results/checkout.har and fix any steps that drifted."

Calling it by hand

bash
curl -s https://volley.sh/mcp \
  -H "Authorization: Bearer $VOLLEY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"check_diagram","arguments":{"source":"A -> B: hi"}}}'

Suggested

↑↓ moveEnter openEsc close

Keyboard shortcuts

/ or Ctrl+KSearch the docs
↑ ↓Move through search results
EnterOpen the highlighted result
Ctrl+EnterOpen the result in a new tab
[ and ]Previous and next page
g then hDocs home
tBack to the top of the page
?Show these shortcuts
EscClose a dialog

The editor has its own shortcuts. See Keyboard shortcuts.