Skip to main content
Glama

PayRam runbooks (one-off admin tasks)

payram_runbook
Read-onlyIdempotent

Step-by-step procedures for changes to a running PayRam, each step marked agent vs human with hard stops: set_site_url, change_domain, ssl_setup, ssl_renewal_fix, firewall_ports, upgrade, backup, restore, add_chain, smart_bridge, mainnet_cutover, operator_setup, rotate_api_key, reset_test_install, shopify_connector, woocommerce_plugin, secure_analytics_mcp, install_failed, custom_port_or_proxy, external_database, forgot_root_password. Omit task to list them.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
taskNoWhich runbook. Omit to list all.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
tasksYes
runbookNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / task / enum
      Previous value: -[
      -  "set_site_url",
      -  "change_domain",
      -  "ssl_setup",
      -  "ssl_renewal_fix",
      -  "firewall_ports",
      -  "upgrade",
      -  "backup",
      -  "restore",
      -  "add_chain",
      -  "smart_bridge",
      -  "mainnet_cutover",
      -  "operator_setup",
      -  "rotate_api_key",
      -  "reset_test_install",
      -  "shopify_connector",
      -  "woocommerce_plugin",
      -  "secure_analytics_mcp"
      -]New value: +[
      +  "set_site_url",
      +  "change_domain",
      +  "ssl_setup",
      +  "ssl_renewal_fix",
      +  "firewall_ports",
      +  "upgrade",
      +  "backup",
      +  "restore",
      +  "add_chain",
      +  "smart_bridge",
      +  "mainnet_cutover",
      +  "operator_setup",
      +  "rotate_api_key",
      +  "reset_test_install",
      +  "shopify_connector",
      +  "woocommerce_plugin",
      +  "secure_analytics_mcp",
      +  "install_failed",
      +  "custom_port_or_proxy",
      +  "external_database",
      +  "forgot_root_password"
      +]
    • changedOutput schema / properties / runbook / properties / steps / items / properties / who / enum
      Previous value: -[
      -  "agent_shell",
      -  "human",
      -  "human_dashboard"
      -]New value: +[
      +  "agent_shell",
      +  "agent_http",
      +  "human",
      +  "human_dashboard"
      +]
    • changedOutput schema / properties / runbook / properties / task / enum
      Previous value: -[
      -  "set_site_url",
      -  "change_domain",
      -  "ssl_setup",
      -  "ssl_renewal_fix",
      -  "firewall_ports",
      -  "upgrade",
      -  "backup",
      -  "restore",
      -  "add_chain",
      -  "smart_bridge",
      -  "mainnet_cutover",
      -  "operator_setup",
      -  "rotate_api_key",
      -  "reset_test_install",
      -  "shopify_connector",
      -  "woocommerce_plugin",
      -  "secure_analytics_mcp"
      -]New value: +[
      +  "set_site_url",
      +  "change_domain",
      +  "ssl_setup",
      +  "ssl_renewal_fix",
      +  "firewall_ports",
      +  "upgrade",
      +  "backup",
      +  "restore",
      +  "add_chain",
      +  "smart_bridge",
      +  "mainnet_cutover",
      +  "operator_setup",
      +  "rotate_api_key",
      +  "reset_test_install",
      +  "shopify_connector",
      +  "woocommerce_plugin",
      +  "secure_analytics_mcp",
      +  "install_failed",
      +  "custom_port_or_proxy",
      +  "external_database",
      +  "forgot_root_password"
      +]
  2. Added

TDQS

A3.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so safety is covered. The description adds real context beyond that: procedures are 'step-by-step', each step is labeled 'agent vs human', and there are 'hard stops'—which tells the agent it must pause and hand off rather than auto-execute. That hand-off semantics is valuable and not derivable from annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The lead clause is well front-loaded and informative, but the bulk of the text is a 21-item enumeration that exactly duplicates the schema enum—repeated structured data that does not earn its place. The informative content is roughly two sentence-fragments padded to one very long line.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return structure need not be explained, and the description covers the tool's nature, the step labeling, hard-stop behavior, and the list-vs-fetch pattern. The remaining gap is sibling disambiguation against payram_ops_playbook/payram_troubleshoot for one-off admin task requests.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the single parameter is a fully enumerated string, so the schema already carries the semantics. The description's re-listing of all 21 enum values and 'Omit task to list them' essentially duplicates the schema's own description, adding no new meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific resource and format: 'step-by-step procedures for changes to a running PayRam', with the agent-vs-human step framing. It is clearly distinguishable from the explain_* and snippet_* families, but it never distinguishes itself from the very similar sibling payram_ops_playbook or payram_troubleshoot, which an agent will also consider for admin tasks.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'Omit task to list them' tells the agent how to discover the available runbooks versus fetching one, which is genuine usage guidance. However, there is no statement of when this tool is preferred over payram_ops_playbook, payram_troubleshoot, or payram_doctor, all of which plausibly compete for the same request.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources