ringkit_get_auto_refill
Read the auto-refill settings (enabled, threshold, amount) and whether a card is saved.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| businessId | No | Defaults to the business of the API key in the Authorization header. |
Read the auto-refill settings (enabled, threshold, amount) and whether a card is saved.
| Name | Required | Description | Default |
|---|---|---|---|
| businessId | No | Defaults to the business of the API key in the Authorization header. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered by structured data. The description's added value is disclosing what is returned (settings plus saved-card status), which matters because there is no output schema, but it says nothing about permission requirements or behavior when no card or no settings exist.
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?
One front-loaded sentence that names the resource first and the returned fields second, with no filler or redundancy.
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?
For a read-only tool with one optional identifier parameter and no output schema, the description covers the essential gap by listing what is returned. It falls short of full completeness only in omitting any note about the empty/not-configured state or tenant scoping.
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?
There is a single optional businessId whose schema description already explains the API-key default and the biz_ pattern, at 100% coverage. The description adds nothing about scoping or defaults, so the schema does the work and baseline 3 applies.
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 uses a specific verb ("Read") with a named resource ("auto-refill settings") and enumerates the returned fields (enabled, threshold, amount, card saved). The read counterpart to the sibling ringkit_put_auto_refill is clear from naming, though the description itself never names that sibling.
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?
There is no explicit when-to-use statement, no prerequisites, and no mention of the alternative ringkit_put_auto_refill for changes. The only guidance is implicit in the verb "Read", leaving the agent to infer the read-versus-write split from tool names alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.