Skip to main content
Glama
zk-armor
by zk-armor

analyze_sphinx_structure

Analyze the structure of a Sphinx documentation project to identify its hierarchy, sections, and files for conversion to Markdown for LLMs.

Instructions

Analyze the structure of a Sphinx documentation project

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
depthNoMaximum depth to analyze
sourcePathYesPath to the Sphinx documentation directory
Behavior2/5

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

With no annotations, the description carries the full burden but only says 'Analyze the structure'. It does not disclose side effects, return format, or the scope of analysis, which is a significant gap.

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?

Single, front-loaded sentence with no unnecessary words. The description is appropriately concise for a simple tool.

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

Completeness2/5

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

There is no output schema, so the description should explain what 'structure' analysis returns, but it does not. The tool has only two well-documented parameters, but completeness is undermined by missing output/behavior details.

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%, with clear descriptions for sourcePath and depth. The description itself adds no parameter detail beyond what the schema already provides, so baseline 3 is appropriate.

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?

Description uses specific verb 'Analyze' with resource 'structure of a Sphinx documentation project', clearly distinguishing it from sibling convert tools. It states exactly what the tool does.

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?

The description implies use for analyzing project structure but provides no explicit when-to-use or when-not-to-use guidance relative to sibling convert tools. No alternatives or exclusions are mentioned.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zk-armor/mcp-sphinx-docs'

If you have feedback or need assistance with the MCP directory API, please join our Discord server