Skip to main content
Glama

OpenSearch description XML

bpj_opensearch_description_xml
Read-onlyIdempotent

Build an OpenSearch 1.1 description from a short name, a search URL and a query parameter.

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": {
      "shortName": "<shortName>",
      "description": "<description>",
      "endpoint": "<endpoint>",
      "parameter": "<parameter>"
    },
    "name": "bpj_opensearch_description_xml"
  }
}

Input Schema

NameRequiredDescriptionDefault
endpointYes
parameterYes
shortNameYes
descriptionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare a pure, idempotent, non-destructive local transformation, and the description is consistent with that while adding the useful detail that the target spec is OpenSearch 1.1. It does not say whether the result is returned as a string, written to a file, or how the inputs are templated into the XML, so the disclosure stops short of what a builder tool should explain.

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 front-loaded sentence with no filler. It is efficient, though the brevity is partly under-specification rather than disciplined editing.

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

Completeness2/5

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

Four required parameters at 0% schema coverage, no output schema, and no explanation of the returned artifact's shape or how the inputs map into the XML template. For a document-builder tool that is not enough to call it confidently in one shot.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry the load, yet it only names three of the four required fields (shortName, endpoint, parameter) and drops the required 'description' field entirely. It adds no meaning about URL format, whether the query parameter uses {searchTerms}, or any escaping behavior.

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 artifact: "Build an OpenSearch 1.1 description" from named inputs. That distinguishes it from generic XML siblings like bpj_sitemap_xml_builder or bpj_release_junit_xml, though it never explicitly contrasts with them.

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 context, no prerequisites, and no named alternatives. The agent must infer that this is for generating OpenSearch/RSS autodiscovery descriptions rather than parsing or validating existing ones.

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.