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

convert_sphinx_file

Convert Sphinx RST files to Markdown optimized for LLMs, making technical documentation easier for language models to consume.

Instructions

Convert a single Sphinx RST file to LLM-optimized Markdown

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
optionsNo
outputPathNoOutput path for the converted Markdown file
sourcePathYesPath to the RST file to convert
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. It only states the basic conversion action but does not explain side effects (e.g., whether outputPath is overwritten), error conditions, or what 'LLM-optimized' entails. This leaves significant behavioral gaps.

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?

The description is a single, concise sentence that immediately states the tool's purpose. There is zero fluff or redundancy, and the key scoping term ('single') is front-loaded.

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?

The tool has a nested options object, no output schema, and no annotations. The description is too minimal to convey what the tool returns, how options like chunkSize and optimize affect output, or any side effects. This lack of completeness makes it hard for an agent to predict behavior for non-trivial conversions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description adds no parameter information at all. Schema coverage is 67% (sourcePath and outputPath have descriptions, but options object lacks a description). Since coverage is not high and the description does not compensate, it provides little value beyond the schema.

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?

The description uses a specific verb ('Convert') and resource ('a single Sphinx RST file') with a clear output ('LLM-optimized Markdown'). The word 'single' distinguishes it from the sibling tool convert_sphinx_directory, making it clear this is for individual files.

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?

The description clearly implies usage for a single file via 'single', providing context that this is for one RST file at a time. However, it does not explicitly mention alternatives like convert_sphinx_directory or exclusions, so it stops short of a 5.

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