Skip to main content
Glama

Generate referral SDK snippet

generate_referral_sdk_snippet
Read-onlyIdempotent

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. Changed2 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

C2.9/5.0
Behavior3/5

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, and the description is consistent with a pure code-generation operation. It adds essentially nothing beyond that profile, though there is no contradiction and no missing safety disclosure to compensate for.

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?

One short, front-loaded sentence with no filler; the purpose is leading. It is tight but arguably under-specified rather than excessively verbose.

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?

An output schema exists, so return-value explanation is not required. For a generator sitting among many near-duplicate snippet siblings, the description is minimally adequate but leaves the key routing question (route vs SDK vs status vs validation snippet) unanswered.

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% and the single parameter (framework, enum: generic-http) is fully documented in the schema. The description adds no syntax, default, or enum context beyond what the schema already provides, so the baseline 3 applies.

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

Purpose3/5

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

States a clear verb (generates) and resource (backend route/service snippet to create a referral event via the Payram SDK), so the basic purpose is legible. However, 'route or service snippet' overlaps ambiguously with the sibling generate_referral_route_snippet, and the description never explains how this differs from that or from generate_referral_status_snippet/validation_snippet.

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 when-to-use guidance, no prerequisites, and no named alternative. With three closely related referral-snippet siblings, an agent has no textual basis for choosing this tool over generate_referral_route_snippet or generate_referral_validation_snippet.

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