Skip to main content
Glama

Particular Service Platform Documentation MCP Server

read_doc

Read-onlyIdempotent

Read one Particular Platform documentation page as Markdown. Long pages are returned in chunks.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesCopy the full URL exactly as printed by search_docs (e.g. https://docs.particular.net/...), or pass a docs:// URI or a site path with a leading slash such as '/nservicebus/sagas/'. Bare relative paths without the leading slash are rejected.
fromCharacterNoZero-based character offset at which to start. Use the continuation value returned for a truncated page. Defaults to 0.
maxCharactersNoMaximum characters to return. Defaults to 40000; values below 1000 are raised to 1000.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already establish a safe read-only, idempotent operation. The description adds useful behavior beyond that: output is Markdown and long pages are chunked. It does not contradict the annotations, though it leaves detailed continuation mechanics to the parameter schema.

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 short sentences with no wasted words; the core action and format are stated first, and the chunking caveat is second. It is appropriately sized for the tool's simplicity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Combined with the rich parameter schema and safety annotations, the description covers what the tool does, what it returns, and its chunking behavior. An agent has enough information to call it correctly, including using the continuation offset for long pages.

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 100%, so the schema already fully documents url, fromCharacter, and maxCharacters. The description's chunk mention gives light context for the offset/limit parameters, but adds little 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?

The description uses a specific verb and resource ('Read one Particular Platform documentation page as Markdown') and clearly indicates this tool fetches a single page rather than searching. It does not explicitly compare itself with search_docs, but the one-page wording is enough to distinguish them.

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: this is the tool you use after search_docs has produced a URL, and the URL parameter says to copy it exactly as printed by search_docs. However, there is no explicit when-to-use/when-not-to-use guidance or an alternative mentioned in the description itself.

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