Skip to main content
Glama

candidate_get_integration_guide

Read-onlyIdempotent

Read one selected candidate declaration and manual review checklist. Does not install, authenticate, execute or establish runtime compatibility. Documentation is not reviewed and vendor integrations are untested. Complete declarations appear once in interfaces; matched/guide entries are explicit local references. Only the retained current observation is available; historical batch queries are not accepted.

Input Schema

NameRequiredDescriptionDefault
idYesExact ID belonging to the selected Registry set; names, aliases and outside-selection IDs are rejected.
typeNo
localeNoExplicit candidate-lane locale extension. No candidate-body translation is performed. Legacy language remains en/zh only.
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 / description
      Added value: +"Input contract for fixed selected Registry metadata only. Schema and contract versions identify their own data contracts, not the application release."
    • addedInput schema / properties / id / description
      Added value: +"Exact ID belonging to the selected Registry set; names, aliases and outside-selection IDs are rejected."
  2. Added

TDQS

B3.2/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive behavior, while the description adds important constraints: no install/authenticate/execute/runtime compatibility, documentation unreviewed, vendor integrations untested, and only the retained current observation available. These are useful behavioral disclosures with no contradiction, though the sentence about 'complete declarations' is opaque.

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?

The description is compact and front-loads the main operation, but the sentence 'Complete declarations appear once in interfaces; matched/guide entries are explicit local references' is cryptic and does not clearly help invocation. Overall size is appropriate, but not every sentence earns its place.

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?

No output schema exists, yet the description does not explain the structure or contents of the returned declaration or checklist. For a 6-parameter tool with several enums and no output schema, this leaves key invocation and interpretation gaps despite useful limitation notes.

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 67%, with descriptions for id, locale, language, and includeChecklist. The description only indirectly hints at includeChecklist via 'manual review checklist' and the retained-observation constraint, and says nothing about type, pricing, locale, or language parameters, so it adds limited meaning beyond the schema.

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 read operation on one selected candidate declaration and manual review checklist. Clear enough to identify the resource, but it does not explicitly connect 'integration guide' to the tool name or distinguish the tool from sibling get_integration_guide or candidate_get_review_summary.

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?

Gives exclusions such as 'historical batch queries are not accepted' and non-actions, but no explicit when-to-use guidance or alternative-tool routing. The agent must infer applicability from the purpose sentence and tool name rather than from stated conditions.

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