Skip to main content
Glama
bdrhoa
by bdrhoa

get_integration_guide

Read-onlyIdempotent

Retrieves sourced Payments Fraud v2 integration guidance and recommendations by topic, including unresolved documentation conflicts, to help developers resolve setup questions.

Instructions

Get sourced Payments Fraud v2 guidance, recommendations and unresolved documentation conflicts.

Input Schema

NameRequiredDescriptionDefault
topicYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is fully covered without the description. The description adds one useful trait beyond them: output is "sourced" and may contain "unresolved documentation conflicts," warning that results can be inconsistent. It says nothing about topic coverage, result format, or whether conflicts are separated from resolved guidance.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no filler; the resource and the nature of the returned content both appear before any qualifier. Nothing can be cut without losing information.

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?

For a one-parameter, read-only lookup with a closed enum and no output schema, the description covers the core purpose but leaves the result shape and the meaning of "unresolved documentation conflicts" unexplained. An agent knows what to ask for but not what it will receive or how to act on conflicting guidance.

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 0%, so the description should clarify the single required parameter, but it never mentions "topic" or how to choose among the six enum values. The enum labels are largely self-explanatory (authentication, webhooks, overview), which limits the practical damage, but the description adds no framing about scope or granularity.

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?

Specific verb ("Get") plus scoped resource ("sourced Payments Fraud v2 guidance, recommendations and unresolved documentation conflicts"), which separates it from the action-oriented siblings like validate_order_payload or generate_order_example. It does not explicitly name get_api_schema as the adjacent alternative, so the boundary is inferable rather than stated.

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: an agent can infer this is the tool for reading topical integration guidance before acting. There is no explicit when-to-use/when-not guidance, and no routing between this tool and get_api_schema or explain_api_error, which cover adjacent knowledge needs.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.