Payram

Generate referral route snippet

generate_referral_route_snippet

Read-onlyIdempotent

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

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "framework": "<framework>"
    },
    "name": "generate_referral_route_snippet"
  }
}

Input Schema

Name	Required	Description	Default
`framework`	Yes	Web framework for the referral route handler (Express.js or Next.js)

Output Schema

Name	Required	Description	Default
`meta`	Yes
`notes`	No
`title`	Yes
`snippet`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedOct 8, 2026

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"

First observedFeb 18, 2026

TDQS

B3.2/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, so the safety profile is fully covered by structured data. The description adds only that the generated route is for 'logging referral events,' which is useful framing but no operational detail (e.g., what the snippet contains, whether it is a stub or runnable code).

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 sentence, front-loaded with the verb and resource, with zero filler. It is appropriately sized for a single-parameter generator, though the example route is the only element that earns extra value.

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?

An output schema exists, so return values need not be described, and annotations cover the safety profile; for a one-parameter tool this is close to complete. The remaining gap is the absence of any cue about when this route snippet is preferred over the referral SDK/status/validation snippet siblings.

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 'framework' parameter has a documented enum (express, nextjs), so the schema carries the full burden. The description mentions nothing about framework selection or how it changes the output, adding no meaning beyond the schema; baseline 3 applies.

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?

States a specific verb and resource ('Generates a backend route') and gives a concrete example path ('/api/referrals/create for logging referral events'), which pins down the artifact. It does not, however, distinguish itself from the many sibling snippet generators (generate_referral_sdk_snippet, generate_referral_status_snippet, generate_referral_validation_snippet), so an agent must infer the boundary from the name alone.

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 or when-not-to-use guidance is given, and no alternative tool is named. With over a dozen sibling 'generate_*_snippet' tools, the description offers no routing signal for picking this one over the SDK, status, or validation variants.

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

All Payram tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?