Skip to main content
Glama

SanctionsKit developer MCP

Read an integration document

get_doc
Read-onlyIdempotent

Read a document returned by search_docs, including code examples and error handling. Uses a fixed local document catalog; does not fetch arbitrary URLs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds real value by confirming the closed local catalog ('fixed local document catalog') and hinting at returned content ('code examples and error handling'), consistent with the annotations.

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?

Two tight sentences, both front-loaded: the positive action first, the negative constraint second. Every clause earns its place; nothing is redundant with the title or schema.

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?

An output schema exists, so return values need no elaboration, and the content hint ('code examples and error handling') is a bonus. The only gap is behavior on an invalid or unknown slug, which the description leaves unaddressed.

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% for the single slug parameter, so the description must carry the load. It usefully identifies the slug's origin (a search_docs result) but says nothing about the allowed character pattern or length limit, which live only in the schema regex and constraints. It compensates partially, not fully.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Read a document returned by search_docs') and pins the source of the identifier, which cleanly separates it from the sibling search_docs. An agent can tell what this does and where its input comes from without opening the schema.

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

Usage Guidelines4/5

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

The phrase 'returned by search_docs' implicitly routes the agent through search_docs first, and the exclusion 'does not fetch arbitrary URLs' defines when-not-to-use-it. It stops short of explicitly naming alternatives like get_api_schema or stating prerequisites, but the context is clear.

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