list-doc-sections
Retrieve section headings from a Kubernetes document to quickly navigate its content.
Instructions
List section headings in a document.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Doc name, e.g. "api-conventions" |
Retrieve section headings from a Kubernetes document to quickly navigate its content.
List section headings in a document.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Doc name, e.g. "api-conventions" |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It does not disclose behavioral traits (e.g., read-only, performance, limitations). A read operation is implied but not confirmed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single sentence, no redundant words. Information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Adequate for a simple tool with one parameter and no output schema, but could include output structure or error conditions.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% (single parameter 'name' well-described). The tool description adds no additional meaning beyond the schema, meeting baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'List section headings in a document.' clearly states the verb (list), resource (section headings), and scope (in a document), distinguishing it from sibling tools like list-docs and read-doc.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use vs alternatives (e.g., when to prefer list-doc-sections over read-doc or list-docs). The description lacks exclusions or context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/Jefftree/k8s-dev-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server