btcpayserver-mcp

btcpay_request

Execute BTCPayServer API operations to manage payment requests, invoices, and lightning services for cryptocurrency payment processing.

Instructions

Execute a BTCPayServer API operation using the service-based approach.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "serviceName": "<serviceName>",
      "methodName": "<methodName>"
    },
    "name": "btcpay_request"
  }
}

Input Schema

Name	Required	Description
`serviceName`	Yes	Service name (e.g., "payment-requests", "invoices", "lightning")
`methodName`	Yes	Method name (e.g., "create", "get", "list", "delete")
`parameters`	No	Parameters for the method (use get_method_info to see required parameters)

Schema Changelog

Changes observed during successful MCP inspections.

First observedOct 12, 2025

TDQS

C2.6/5.0

Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool executes API operations but doesn't disclose critical traits like authentication requirements, rate limits, error handling, or whether it performs read/write operations. This leaves significant gaps in understanding how the tool behaves in practice.

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

Conciseness4/5

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

The description is a single, efficient sentence that clearly states the tool's function without unnecessary words. It is appropriately sized and front-loaded, though it could be slightly more informative without losing conciseness.

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

Completeness2/5

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

Given the complexity of a generic API tool with three parameters, no annotations, and no output schema, the description is incomplete. It fails to explain what the tool returns, how errors are handled, or provide context on the service-based approach, making it inadequate for effective agent use without additional documentation.

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?

The schema description coverage is 100%, so the input schema already documents the three parameters (serviceName, methodName, parameters) with descriptions. The description adds no additional meaning beyond what the schema provides, such as examples of common use cases or parameter interactions, resulting in a baseline score.

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

Purpose3/5

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

The description states the tool executes BTCPayServer API operations using a service-based approach, which provides a general purpose but lacks specificity about what resources or actions it handles. It doesn't distinguish from sibling tools like get_method_info or get_service_info, making it somewhat vague about its exact function beyond being a generic API caller.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus alternatives. The description mentions a service-based approach but doesn't explain when to choose this over other methods or tools, leaving the agent without clear usage context or exclusions.

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

Deploy Server