Skip to main content
Glama
Severnbli

telegram-bot-framework-mcp

by Severnbli

list_doc_sections

Lists the available sections in a project's README so AI assistants can locate relevant documentation before reading detailed guidance.

Instructions

List README sections.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure, yet it only implies a read via "List". It says nothing about what a "section" is (headings? anchors?), whether the result covers the whole README or is paginated, or what the identifiers returned look like for feeding into get_doc_section.

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?

A single short sentence with no filler and the resource front-loaded. It is efficient, but the brevity borders on under-specification rather than tightness.

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

Completeness3/5

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

With zero parameters and an output schema present, the description need not explain return values, so it is close to sufficient for a trivial list call. The remaining gap is disambiguation from list_guide_sections/get_doc_section and what exactly a README "section" is.

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?

The tool takes zero parameters, so there is nothing to disambiguate and the description needs no parameter guidance. The 4 baseline applies; 5 is withheld only because empty input semantics (e.g. whether it always targets the repo README) are not stated.

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

Purpose3/5

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

"List README sections" names a concrete verb and resource, so the basic operation is understandable. However, it gives no differentiation from close siblings such as list_guide_sections and get_doc_section, so an agent cannot tell from the text alone which of these to reach for.

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

Usage Guidelines2/5

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

There is no statement of when to use this tool versus list_guide_sections or get_doc_section, and no preconditions or exclusions. Usage has to be guessed from sibling names rather than inferred from the description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.