Retrieve a list of all merchant profiles with optional pagination and sorting to review configured payment processors.
Lists all merchant profiles. This tool ONLY reads data.
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | Number of merchant profiles to return | |
| order | No | Sort order | |
| since_token | No | Pagination token |
Changes observed during successful MCP inspections.
v0.1.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotation readOnlyHint=true already indicates safe read operation. The description adds only that it 'ONLY reads data', which is redundant. It does not disclose pagination behavior, default ordering, or result structure beyond what the schema implies.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with no fluff. The key action and read-only nature are front-loaded. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
As a paginated list tool with no output schema, the description should explain pagination (e.g., how since_token works) and default behavior. It omits these details, making it incomplete for effective use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds no additional context about parameters (count, order, since_token) beyond their schema descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Lists all merchant profiles', which is a specific verb and resource. This distinguishes it from sibling tools like spreedly_merchant_profile_show, which likely retrieves a single profile.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives, such as spreedly_merchant_profile_show or other list tools. The description does not mention prerequisites, filters, or exclusion criteria.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.