Skip to main content
Glama

PCFHub

Read a documentation page

get_doc_page
Read-onlyIdempotent

Read one documentation section of a control as Markdown — installation steps, canvas or model-driven configuration, examples, limitations. Use list_doc_sections first to see which sections exist.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe control's slug, e.g. "pcf-tag-list".
sectionYesWhich section to read.
versionNoDocumentation pinned to a specific release. Defaults to the current documentation.

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 cover the safety profile (readOnlyHint, idempotentHint), so the bar is lower. The description still adds useful behavior beyond the schema: the response is Markdown and covers exactly one section, which matters because there is no output schema. It does not discuss pagination or size limits, so not a 5.

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 sentences, both earning their place: the first defines scope and output format, the second routes to the discovery tool. The most decision-relevant information is front-loaded.

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?

With no output schema, the description usefully declares the return format (Markdown) and single-section scope, and the schema fully covers parameters. The version-pinning behavior is only in the schema, and no return-size or error behavior is mentioned, so it is strong but not exhaustive.

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 slug, section, and version are already documented in the schema, including the enum and the version default. The description's mention of installation/canvas/model-driven/examples/limitations loosely mirrors enum members but adds no syntax or format detail. Baseline 3 applies.

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 (Read) and resource (one documentation section of a control) plus the return format (Markdown) and enumerates the kinds of content returned. It is clearly distinguishable from list_doc_sections, which it names explicitly.

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?

Gives an explicit prerequisite routing rule: 'Use list_doc_sections first to see which sections exist.' This tells the agent how to discover valid section values before calling. It stops short of stating when not to use the tool or naming a sibling for a conflicting case, so it is not a full 5.

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