Skip to main content
Glama

get_integration_guide

Read-onlyIdempotent

Read integration guidance for human review. includeChecklist:true explicitly adds manual review steps and known/unknown source dates, authorization and runtime requirements. Optional pricing:"summary" adds scoped pricing-0.4.2 status for the selected interfaces, preserving the full software coverage denominator. 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

NameRequiredDescriptionDefault
idYes
typeNo
pricingNo
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
includeChecklistNoExplicitly add manual source/auth/runtime/configuration/price review steps. Never executes configuration.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / includeChecklist
      Added value: +{
      +  "default": false,
      +  "description": "Explicitly add manual source/auth/runtime/configuration/price review steps. Never executes configuration.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / pricing
      Added value: +{
      +  "enum": [
      +    "summary"
      +  ],
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already establish the safety profile (readOnly, idempotent, non-destructive, closed-world), but the description adds substantial context beyond them: it clarifies that it installs/runs/configures nothing, that listed vendor integrations are untested, that 'docs-reviewed' means documentation review only, and that results include vendorTestingPolicy which does not certify vendors. These trust/verification caveats are genuinely valuable and not present in the structured fields.

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 purpose is front-loaded and every sentence carries information about behavior or parameters. It is dense and somewhat run-on with inline quoted parameter syntax, but little is redundant.

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 is close to complete: it covers purpose, the two most consequential optional parameters, and the trust caveats around vendor testing. It stops short of explaining id/type semantics, which are the remaining gaps.

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 coverage is only 40%, so the description should compensate more than it does. It explains two parameters well (includeChecklist:true adds manual review steps and source/auth/runtime requirements; pricing:"summary" adds scoped pricing status), but leaves id and type undocumented in both schema and description, so the low coverage is only partially offset.

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 resource: 'Read integration guidance for human review.' The scope (integration guidance, for human review) is clear and distinct from data-retrieval siblings like get_software or list_rankings, though it never explicitly names or contrasts those siblings.

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?

Usage is implied by 'for human review' and the negative clause 'Does not install, run or configure anything,' which signals when this tool is appropriate versus taking action. However, it gives no explicit when-to-use condition relative to the sibling tools (compare_software, get_software, get_review_summary), leaving selection to inference.

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