Skip to main content
Glama

Search xmcp documentation.

search
Read-onlyIdempotent

Search xmcp documentation.

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": "search"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNoDocument ID (e.g. 'configuration/transports')
queryNoSearch query for docs

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / id / $schema
      Added value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / properties / query / $schema
      Added value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

C2.4/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so the safety profile is covered without the description. The description adds nothing beyond that: no result format, no matching semantics, no statement of whether id and query are mutually exclusive or combinable, no handling of empty results.

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?

One short sentence with no padding, so it is maximally concise and front-loaded. But that brevity comes from duplicating the title, not from discipline — nothing is left after removing the restatement.

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?

The tool is simple: two fully documented optional parameters, strong annotations, no output schema, no nesting. The schema and annotations carry most of the burden, so the description is only just adequate; it should at least explain the id-vs-query choice, which is the main ambiguity in calling this tool 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%, with the id parameter even carrying a concrete example ('configuration/transports'), so the schema does the heavy lifting and baseline 3 applies. The description contributes no additional meaning about how id and query interact or what happens when both or neither are supplied.

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

Purpose2/5

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

Tautological: description restates name/title.

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?

There is no guidance on when to use it versus anything else, no prerequisites, and no note about how to combine the id and query parameters (e.g. fetch-by-id vs. free-text search). The only hint is the parameter names themselves, which the schema already provides.

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