Skip to main content
Glama

Get venue referral code

get_referral_code
Read-onlyIdempotent

Retrieve a venue's referral code and link from the cp0x catalog so users can access referral details for a named venue.

Instructions

Find a venue's referral code and link in the cp0x catalog. Use this when a user requests referral details for a named venue; links include a cp0x referral code.

Input Schema

NameRequiredDescriptionDefault
venueYesVenue name or deal slug to match.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and openWorldHint=true, so the safety profile is covered. The description adds that returned links embed a cp0x referral code, but says nothing about behavior when the venue is not found or how the lookup is resolved.

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?

Two short sentences, front-loaded with the outcome and then the selection condition. No filler.

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?

For a single-parameter read-only lookup with no output schema, the description says what is returned (referral code and link, in the cp0x catalog) and when to call it. Only the not-found behavior and output shape are unstated, which are minor gaps.

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?

Schema coverage is 100% and the venue parameter already documents 'Venue name or deal slug to match.' The description only restates 'named venue,' adding no format, matching, or ambiguity-resolution detail beyond the schema.

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

Purpose5/5

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

States a precise verb (Find) and resource (a venue's referral code and link) and scopes it to the cp0x catalog, which is unlike any sibling such as get_deal or list_deals. An agent can tell this is a referral-code lookup without opening the schema.

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

Usage Guidelines4/5

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

Gives an explicit trigger: 'Use this when a user requests referral details for a named venue.' It does not name an alternative or state when not to use it, but the trigger condition is clear enough for selection.

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