Skip to main content
Glama

list_lightning_channels

Retrieve detailed information about Lightning Network channels for a BTCPay Server store, including remote nodes, channel capacity, balances, and current status.

Instructions

List Lightning channels for the store's Lightning node.

Args: crypto_code: Crypto code (e.g., 'BTC', 'BTCTest'). Default: 'BTC'.

Returns channel list with remote node, capacity, balances, and status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
crypto_codeNoBTC

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

With no annotations provided, the description carries the full burden. It discloses the return structure (remote node, capacity, balances, status) but fails to explicitly state safety characteristics (read-only vs. destructive) or performance traits like pagination.

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

Conciseness5/5

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

Efficient docstring-style structure with distinct Args and Returns sections. No redundant text; every sentence provides specific value beyond the structured schema fields.

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?

Appropriately complete for a single-parameter tool with an output schema. The parameter is fully documented and return values are previewed. Minor gap: lacks explicit read-only confirmation which would be helpful given the absence of annotations.

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

Parameters5/5

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

Excellent compensation for 0% schema description coverage. The description fully documents the `crypto_code` parameter with clear semantics (Crypto code), concrete examples (e.g., 'BTC', 'BTCTest'), and default value ('BTC').

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 the specific action (List) and resource (Lightning channels) with scope (store's Lightning node). However, it does not explicitly differentiate from sibling `get_lightning_info`, which may also return Lightning-related data.

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?

Provides no explicit guidance on when to use this tool versus siblings like `get_lightning_info` or `list_invoices`. The description only implies usage through the return value description but lacks when/when-not guidance.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ThomsenDrake/btcpay-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server