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. 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

TableJSON Schema
NameRequiredDescriptionDefault
tool_defsNoCO 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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
      +}
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare this is a safe, read-only, idempotent, non-destructive, non-open-world operation. The description adds meaningful behavioral context: it explains what is returned (Markdown help text covering quick-start, tenant_id, cart persistence, product IDs, auth, workflows) and discloses the tool_defs behavior for served-but-unlisted root tools, including how to invoke them directly or via federation_act.

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 front-loaded with the core purpose and the call-first instruction. It is dense and somewhat jargon-heavy in the CO 529 disclosure section, but each part earns its place by explaining return content, parameter behavior, and an example invocation.

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 help tool with no output schema and one well-documented optional parameter, the description is complete. It covers what the tool returns, why it should be called first, how tool_defs works, and which topics the help text addresses, giving an agent enough to invoke and use it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% for the single tool_defs parameter, so the baseline is 3. The main description still adds value by explaining that tool_defs can be 'all' or a specific tool name and by describing the downstream invocation path for unlisted tools, though some of this repeats the schema parameter description.

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 tells the agent when this is most important ('CALL THIS FIRST') and scopes the content to product IDs, authentication flow, and federation tool usage, making it clearly distinct from operational siblings like federation_act or federation_search.

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

Usage Guidelines4/5

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

The description gives strong usage context: 'CALL THIS FIRST to understand how to use tools correctly' and explains how to use the optional tool_defs parameter to retrieve unlisted tool schemas. It does not state when not to use this tool or name alternative help/about siblings, so it misses the top level of explicit alternatives.

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.