Skip to main content
Glama

PCFHub

List a control's documentation

list_doc_sections
Read-onlyIdempotent

The documentation sections a control has — overview, installation, canvas, model_driven, examples, limitations and so on. Call get_doc_page with one of the returned sections to read it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe control's slug, e.g. "pcf-tag-list".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safe-read profile is covered. The description adds that the sections are variable per control ('and so on'), which is useful, but says nothing about ordering, return shape, or the failure mode when a slug has no docs. Adequate but not rich given the low bar set by annotations.

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?

Two short sentences, front-loaded with the resource and followed by the routing instruction — nothing superfluous. The first sentence is a fragment without a verb, which slightly weakens the lead.

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?

For a one-parameter read-only enumerator with no output schema, the description supplies the resource, the example section values the agent will receive, and the follow-up call. Nothing needed to invoke it correctly is missing.

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 coverage is 100% and the single slug parameter is fully documented with an example in the schema itself. The description only alludes to 'a control' and adds no format, casing, or resolution detail beyond the schema. Baseline 3 is correct here.

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 names the resource precisely (documentation sections belonging to a control) and enumerates concrete examples — overview, installation, canvas, model_driven, examples, limitations. It is distinguishable from the sibling get_doc_page because it explicitly frames itself as the discovery step. It lacks a strong leading verb ('lists'), which keeps it from a 5.

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?

It gives an explicit next-step rule: 'Call get_doc_page with one of the returned sections to read it,' which tells the agent how this tool pairs with the alternative. It does not state when *not* to use this tool or any prerequisites, so it falls short of the 5 standard.

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