Skip to main content
Glama

capalens

get_integration_guide

Read-onlyIdempotent

Read integration guidance for human review. Does not install, run or configure anything. Listed vendor MCP/API/CLI integrations are untested; docs-reviewed means documentation review only. Results include vendorTestingPolicy; CapaLens protocol tests do not test or certify vendors.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
typeNo
languageNoOutput language, including vendorTesting labels and vendorTestingPolicy. English is the default; IDs, URLs, documentation verification values and commands are unchanged. Vendor integrations remain untested in both languages.en

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed world), so the description's added value is its disclosure of data trustworthiness: vendor integrations are untested, docs-reviewed means documentation review only, vendorTestingPolicy is returned, and CapaLens protocol tests do not certify vendors. This is exactly the caveat an agent needs to avoid overstating coverage.

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?

Four short, front-loaded sentences with no filler. The untested/certify caveat is restated in three slightly different ways ('are untested', 'documentation review only', 'do not test or certify vendors'), which is mildly redundant though defensible for emphasis.

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 read-only tool with no output schema, the description supplies the necessary caveats about what the returned guidance means and notes that results include vendorTestingPolicy. It stops short of describing what the guide actually contains or the expected id format, a minor gap for a single-lookup tool.

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 only 33% – only the 'language' parameter is documented, leaving 'id' (with a length constraint but no format hint) and the 'type' enum unexplained. The phrase 'Listed vendor MCP/API/CLI integrations' faintly echoes the type enum, but the description adds no real meaning about the required id's form or the effect of the type filter, so it fails to compensate for the coverage gap.

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+resource: reading integration guidance, and clarifies it is for human review rather than execution. It does not name any sibling (e.g., get_software, compare_software) to distinguish the integration-guide scope from software records, so an agent must infer the boundary.

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

Usage Guidelines3/5

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

'Does not install, run or configure anything' rules out a category of misuse and gives clear context about the read-only, human-review use case. However, it never says when to prefer this over get_software or other siblings, and no prerequisites or routing conditions are given.

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