Get Referral Code Details
get_referral_code_detailsGet public details for a referral code.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| referralCode | Yes |
get_referral_code_detailsGet public details for a referral code.
| Name | Required | Description | Default |
|---|---|---|---|
| referralCode | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe read operation. The description adds no further behavioral context (e.g., behavior on invalid code, rate limits). It is consistent but doesn't enhance transparency beyond annotations.
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?
The description is a single sentence, which is concise, but it lacks necessary details like output format or behavior on errors. It is not wasteful, but it under-specifies for a single-parameter tool.
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?
Without an output schema, the description should explain what 'public details' includes. It does not enumerate return fields (e.g., owner, reward info), leaving the agent unaware of the response structure. Sibling tools like get_my_referral_earnings have richer descriptions.
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?
With 0% schema description coverage, the description should clarify the 'referralCode' parameter, but it only repeats the purpose. It fails to explain what constitutes a valid referral code or add meaning beyond the schema's type and minLength.
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 the verb 'Get' and resource 'public details for a referral code', distinguishing it from sibling tools like create_my_referral_code. It is specific and unambiguous.
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?
The description provides no guidance on when to use this tool versus alternatives, such as get_business_referral_reward_summary or retrieve_or_create_business_referral_code. There are no prerequisites or context for usage.
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.