Skip to main content
Glama

Generate referral SDK snippet

generate_referral_sdk_snippet

Generates a backend route or service snippet to create a referral event using the Payram SDK.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
frameworkYesTarget framework for the referral SDK snippet

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
metaYes
notesNo
titleYes
snippetYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries full responsibility for behavioral disclosure. It does not state whether the snippet is returned inline, written to a file, or how it integrates with the framework. It also omits the fact that only 'generic-http' is currently supported, which is important behavioral context beyond the schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence with no unnecessary filler. It is efficient, though the phrase 'backend route or service snippet' could be more precise. Overall, it earns a strong conciseness score.

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?

This is a simple tool with one documented parameter and an output schema present, so the description need not detail return values. However, it lacks guidance on when to use it and does not mention the supported framework constraint beyond what the schema already shows. Adequate for a minimal generator but not comprehensive.

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 description coverage is 100% because the only parameter 'framework' has a description and enum. The tool description adds nothing beyond the schema, but per the rubric baseline 3 applies when schema already thoroughly documents parameters.

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

Purpose4/5

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

The description uses a specific verb 'Generates' and names the resource: 'a backend route or service snippet to create a referral event using the Payram SDK.' It distinguishes from pure route snippets by emphasizing the SDK, though the 'route or service' phrasing is slightly ambiguous.

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

Usage Guidelines2/5

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

No guidance is provided about when to use this tool versus alternatives like generate_referral_route_snippet. There is no mention of prerequisites, when SDK-based snippets are preferred, or any exclusions, leaving the user without context for selection.

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