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. With tenant_id (CO 721), tool_defs answers that tenant's platform tools instead: one name, several as "a,b", or "all". 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 {}.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "federation_help"
  }
}

Input Schema

NameRequiredDescriptionDefault
tenant_idNoWith tool_defs: answer this tenant's platform tool definitions (input_schema, annotations, contract) instead of the root tools'. No token needed.
tool_defsNoTool definitions on request. Without tenant_id (CO 529): "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. With tenant_id (CO 721): the same for that tenant's platform tools, the names in federation_enter_tenant's platform_tools: one name, several as "a,b,c" (at most 25), or "all". Omit for the usage guide.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / tenant_id
      Added value: +{
      +  "description": "With tool_defs: answer this tenant's platform tool definitions (input_schema, annotations, contract) instead of the root tools'. No token needed.",
      +  "maxLength": 64,
      +  "type": "string"
      +}
    • 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, annotations); a tool name returns that one def. Omit for the usage guide."New value: +"Tool definitions on request. Without tenant_id (CO 529): \"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. With tenant_id (CO 721): the same for that tenant's platform tools, the names in federation_enter_tenant's platform_tools: one name, several as \"a,b,c\" (at most 25), or \"all\". Omit for the usage guide."
    • changedInput schema / properties / tool_defs / maxLength
      Previous value: -4000New value: +2000
  2. 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."
  3. 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"
      +}
  4. First observed

TDQS

A3.6/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 safety is covered. The description adds real context beyond that — that it returns Markdown help text, that tenant_id requires no token, and that tool_defs expands served-but-unlisted root tools — but does not state size limits, caching, or what happens when a tool name doesn't match.

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

Conciseness3/5

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

Purpose and the CALL THIS FIRST imperative are correctly front-loaded, but the second paragraph is a run-on wall of clauses dense with unexplained internal tags ("CO 529", "CO 721", "list-gated clients") that force re-reading. The content is largely earning its place, but it needs restructuring into shorter statements.

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?

For a two-optional-parameter, read-only help tool with no output schema, the description covers return format (Markdown help text and its sections), the dual help/tool_defs modes, and the authentication and product-ID topics the guide contains. Enough for an agent to decide to call it and what to expect, aside from unresolved jargon.

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 documents both parameters in full, including the "Omit for the usage guide" behavior. The description restates the same tenant_id/tool_defs semantics with little added syntax or format detail, so 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?

Opens with a specific verb+resource ("Get usage instructions for the MCP federation") and explicitly positions itself ahead of siblings with "CALL THIS FIRST." The second half introduces a second job (returning tool definitions via tool_defs) that muddies the single-purpose framing, though both functions are named concretely.

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?

Gives strong when-to-use direction: call this first, use tool_defs to expand the always-on core, use federation_act from list-gated clients, and route prompt questions to introspection_prompt_library and federation_prompt_run. No explicit when-not to call it, and the tenant_id/tool_defs conditions are stated in dense internal jargon rather than plain conditional language.

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.