Skip to main content
Glama

check_doxygen_install

Check Doxygen installation and verify availability of Graphviz DOT and LaTeX capabilities. Use to ensure documentation toolchain is complete and ready.

Instructions

Verify Doxygen installation and capabilities

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
check_dotNo
check_latexNo
detailedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The main tool handler for check_doxygen_install. Decorated with @mcp.tool(), it runs 'doxygen --version' via subprocess and returns a success/error message based on the result.
    @mcp.tool()
    async def check_doxygen_install(
        check_dot: bool = True,
        check_latex: bool = True,
        detailed: bool = False,
    ) -> str:
        """Verify Doxygen installation and capabilities"""
        try:
            result = subprocess.run(["doxygen", "--version"], capture_output=True, text=True)
            if result.returncode == 0:
                version = result.stdout.strip()
                return f"✅ Doxygen {version} is installed and working!"
            else:
                return "❌ Doxygen is not working properly"
        except FileNotFoundError:
            return "❌ Doxygen is not installed"
  • The tool is registered via the @mcp.tool() decorator on the async function, which registers it with the FastMCP server instance named 'mcp'.
    @mcp.tool()
  • The FastMCP server instance ('mcp') used for tool registration; the @mcp.tool() decorator registers check_doxygen_install as an MCP tool.
    mcp = FastMCP("Doxygen")
  • The function signature defines the input schema: check_dot (bool, default True), check_latex (bool, default True), and detailed (bool, default False). Returns a str.
    async def check_doxygen_install(
        check_dot: bool = True,
        check_latex: bool = True,
        detailed: bool = False,
    ) -> str:
Behavior2/5

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

With no annotations, the description should disclose behavior fully. It only says 'Verify' without explaining what is checked, how results are returned, or side effects. The boolean parameters suggest configurable checks, but this is not stated.

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 very short (5 words), which is concise but too brief for a tool with 3 parameters. It sacrifices necessary detail.

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?

Given the output schema exists, return values need not be explained. However, the tool's three boolean parameters have no descriptions, making the tool's usage unclear for agents.

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

Parameters1/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 mentions no parameters, leaving their purpose completely undocumented.

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

Purpose4/5

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

The description 'Verify Doxygen installation and capabilities' clearly states the verb and resource, distinguishing it from creation tools. However, it does not explicitly differentiate from siblings like validate_documentation.

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?

No guidance on when to use this tool versus alternatives. The description lacks any context about prerequisites or appropriate scenarios.

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/Positronikal/doxygen-mcp'

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