Skip to main content
Glama

generate_manpage

Create man pages in troff format by specifying program name, description, options, and examples.

Instructions

Generate a man page in troff format.

Args: program_name: Program name description: Program description version: Version string synopsis: Usage synopsis line options: List of option dicts with keys: flag, description examples: List of example dicts with keys: command, description author: Author name

Behavior: This tool generates structured output without modifying external systems. Output is deterministic for identical inputs. No side effects. Free tier: 10/day rate limit. Pro tier: unlimited. No authentication required for basic usage.

When to use: Use this tool when you need structured analysis or classification of inputs against established frameworks or standards.

When NOT to use: Not suitable for real-time production decision-making without human review of results. Behavioral Transparency: - Side Effects: This tool is read-only and produces no side effects. It does not modify any external state, databases, or files. All output is computed in-memory and returned directly to the caller. - Authentication: No authentication required for basic usage. Pro/Enterprise tiers require a valid MEOK API key passed via the MEOK_API_KEY environment variable. - Rate Limits: Free tier: 10 calls/day. Pro tier: unlimited. Rate limit headers are included in responses (X-RateLimit-Remaining, X-RateLimit-Reset). - Error Handling: Returns structured error objects with 'error' key on failure. Never raises unhandled exceptions. Invalid inputs return descriptive validation errors. - Idempotency: Fully idempotent — calling with the same inputs always produces the same output. Safe to retry on timeout or transient failure. - Data Privacy: No input data is stored, logged, or transmitted to external services. All processing happens locally within the MCP server process.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
program_nameYes
descriptionYes
versionNo1.0.0
synopsisNo
optionsNo
examplesNo
authorNo
api_keyNo
Behavior4/5

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

With no annotations, the description carries full burden. It includes a detailed 'Behavioral Transparency' section covering side effects (read-only, no side effects), authentication, rate limits, error handling, idempotency, and data privacy. However, some parts appear generic (e.g., 'MEOK API key') and may not be perfectly tailored to this tool, but overall it provides extensive behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the purpose and well-organized into sections (Args, Behavior, When to use/not, Behavioral Transparency). However, it is somewhat verbose, particularly the generic 'When to use' and 'Behavioral Transparency' sections which contain text that seems templated rather than tool-specific.

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?

The description covers the tool's purpose, parameters, and behavioral traits, but it does not explicitly describe the output format beyond 'troff format.' It lacks details on the return value structure (e.g., a string containing the man page) and the 'When to use' section is misleading. For a tool with 8 parameters and no output schema, it is incomplete.

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 0%, so the description must compensate. It lists all parameters and describes nested keys for 'options' and 'examples' (e.g., 'keys: flag, description'). However, it lacks deeper explanations for most parameters (e.g., no format or constraints for program_name). It adds some meaning beyond the schema but not enough for full coverage.

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 clearly states the tool's purpose: 'Generate a man page in troff format.' This specific verb+resource combination distinguishes it from siblings (generate_argparse, generate_click, parse_help_text), which focus on other aspects like argument parser generation or help text parsing.

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?

The 'When to use' section is generic and misaligned: 'Use this tool when you need structured analysis or classification of inputs against established frameworks or standards.' This does not describe when to generate a man page. The 'When NOT to use' is also generic. No explicit guidance on when to choose this tool over siblings is provided.

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/CSOAI-ORG/cli-builder-ai-mcp'

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