Skip to main content
Glama

ADITUS Developer Portal MCP

Get an integration guide

get_guide
Read-onlyIdempotent

Markdown of an integration guide. 'micro-frontend' is the compact Shop Micro Frontend contract for coding agents (mounting, sessions, styling, Web Component, lifecycle, security); 'micro-frontend-docs' is the complete Micro Frontend documentation as on the website; 'micro-frontend-overview' is the non-technical overview (what it is, purchase flow, base setup, add-on levels); module guides such as 'guidelines' or 'webhooks' come from the API reference. Pass a section heading to fetch only that section.

Input Schema

NameRequiredDescriptionDefault
guideYesGuide id, e.g. 'micro-frontend', 'micro-frontend-docs', 'micro-frontend-overview', 'guidelines', 'webhooks'
sectionNoOptional section heading (or slug) to return only that part

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / guide / description
      Previous value: -"Guide id, e.g. 'micro-frontend', 'guidelines', 'webhooks'"New value: +"Guide id, e.g. 'micro-frontend', 'micro-frontend-docs', 'micro-frontend-overview', 'guidelines', 'webhooks'"
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered. The description adds real behavioral context beyond that: the payload is Markdown, and supplying a section returns only a slice of the document rather than the whole guide. No mention of size limits or truncation, but the bar is lower with annotations present.

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?

Front-loads the return format ('Markdown of an integration guide') before the catalogue, and the final sentence covers the optional narrowing parameter. Dense but each clause carries distinct information; the long middle enumeration is justified by the four guide families it disambiguates.

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?

No output schema exists, so the description carries the burden of describing return values, and it does so (Markdown, full guide or single section). With 100% schema coverage and read-only annotations, the definition leaves no blocking gap for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description genuinely adds meaning the schema does not: it explains what each guide id actually contains and clarifies that 'section' accepts a heading or slug. This is additive rather than restating the schema's example list.

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 clearly that it returns Markdown content for an integration guide and then catalogues the distinct guide families, so an agent knows exactly what resource is fetched. It distinguishes among the guide variants (compact contract vs. full docs vs. non-technical overview), though it never names or contrasts the sibling tools (search_docs, list_modules, get_endpoint).

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?

The catalogue implies when each guide id is appropriate, and the closing sentence explains that passing a section heading narrows the fetch. There is no explicit guidance on when to prefer this over search_docs (e.g., when the guide id is unknown) or any exclusion, so usage is only implied.

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