Skip to main content
Glama

federation_help

Read-onlyIdempotent

Get usage instructions for the MCP federation. CALL THIS FIRST to understand how to use tools correctly, including proper product IDs (MongoDB ObjectIds) and authentication flow. Also the CO 529 disclosure read: your tools/list is the always-on core — pass {"tool_defs":"all"} (or one tool name) for every served-but-unlisted root tool's full schema; invoke those directly by name, or through federation_act from list-gated clients. The guide's Prompts section covers the governed prompt library — there's a prompt for that: search it with introspection_prompt_library, run one with federation_prompt_run. Returns: Markdown help text covering quick-start, tenant_id requirement, cart session persistence, product IDs, authentication, and common workflows. Example: call federation_help with arguments {}.

Input Schema

NameRequiredDescriptionDefault
tool_defsNoCO 529 disclosure: "all" returns every served-but-unlisted root tool's full def (name, description, input_schema, required_scope, annotations); a tool name returns that one def. Omit for the usage guide.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / tool_defs / description
      Previous value: -"CO 529 disclosure: \"all\" returns every served-but-unlisted root tool's full def (name, description, input_schema, required_scope); a tool name returns that one def. Omit for the usage guide."New value: +"CO 529 disclosure: \"all\" returns every served-but-unlisted root tool's full def (name, description, input_schema, required_scope, annotations); a tool name returns that one def. Omit for the usage guide."
  2. Changed2 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / tool_defs
      Added value: +{
      +  "description": "CO 529 disclosure: \"all\" returns every served-but-unlisted root tool's full def (name, description, input_schema, required_scope); a tool name returns that one def. Omit for the usage guide.",
      +  "maxLength": 4000,
      +  "type": "string"
      +}
  3. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnly/idempotent annotations, it discloses the return format as Markdown help text and lists the topics covered: quick-start, tenant_id requirement, cart session persistence, product IDs, authentication, and common workflows. It also explains what tool_defs='all' versus a single tool name returns.

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 core instruction is front-loaded and the return contents are stated clearly. Some phrasing, such as the dense 'CO 529 disclosure' sentence and the example call with empty arguments, is less essential, but overall the description remains reasonably efficient for a help/discovery tool.

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

Completeness5/5

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

For a no-required-parameter help tool with no output schema, the description provides enough detail about what is returned and when to call it. The authentication, tenant, prompt-library, and tool-schema disclosure behaviors are all covered sufficiently for an agent to use it correctly.

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%, so the schema already explains the single optional tool_defs parameter. The description mirrors that behavior and adds some invocation context, but does not add meaningfully deeper parameter semantics beyond the structured field.

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 states a specific verb and resource: get usage instructions for the MCP federation. It also clarifies the dual role of the tool via the tool_defs parameter, and distinguishes itself from siblings by naming federation_act, introspection_prompt_library, and federation_prompt_run.

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

Usage Guidelines5/5

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

It explicitly says 'CALL THIS FIRST' and explains how to use tool_defs to retrieve served-but-unlisted tool schemas. It also names alternatives for prompt-library discovery and execution, giving the agent clear routing guidance.

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