Skip to main content
Glama

Generate referral route snippet

generate_referral_route_snippet

Generates a backend route such as /api/referrals/create for logging referral events.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
frameworkYesWeb framework for the referral route handler (Express.js or Next.js)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
metaYes
notesNo
titleYes
snippetYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior2/5

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

With no annotations provided, the description must fully disclose behavior. It ambiguously says 'Generates a backend route' without clarifying that it returns a code snippet rather than actually modifying a live system. This could mislead the agent into thinking the tool has side effects. No details about output format, permissions, or limitations are given, leaving a significant transparency gap.

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?

The description is a single, front-loaded sentence with zero fluff. It immediately states the action and resource, and every word contributes to the purpose. This is appropriately sized for a simple one-parameter tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity, the description combined with the schema and output schema covers the basic invocation. However, the ambiguity about whether it generates a live route or a code snippet is not resolved, and without output schema details visible, the description alone feels incomplete. It adequately covers functionality but lacks the clarity needed for a fully self-contained description.

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?

The input schema already provides 100% coverage for the sole parameter 'framework' with a description and enum values, so the baseline is 3. The tool description adds no extra meaning about the parameter, but the schema fully explains it, so no additional compensation is needed.

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?

The description clearly states the tool's function: 'Generates a backend route such as /api/referrals/create for logging referral events.' It names a specific verb (Generates), resource (backend route), and scope (for logging referral events), and the example path distinguishes it from sibling snippet generators like payment route or referral SDK snippets.

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

Usage Guidelines3/5

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

The description implies the tool is for generating backend route code for referral event logging, but it provides no explicit guidance on when to use this tool versus alternatives like generate_referral_sdk_snippet or generate_payment_route_snippet. No exclusions or alternative tools are mentioned, so usage context is only implied by the example path.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources