Skip to main content
Glama
lethain
by lethain

load_systems_documentation

Load systems documentation, examples, and specifications to enhance model accuracy in generating system specifications.

Instructions

Load systems documentation, examples, and specification details to improve the models ability to generate specifications.

Returns: Documentation and several examples of systems models

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • main.py:42-57 (handler)
    The main handler function for the 'load_systems_documentation' tool. It loads documentation from predefined files into a global cache if not already loaded and returns it as a formatted string.
    @mcp.tool()
    async def load_systems_documentation() -> str:
        """Load systems documentation, examples, and specification details to improve
        the models ability to generate specifications.
        
        Returns:
            Documentation and several examples of systems models
        """
        global DOC_CACHE
        if DOC_CACHE is None:
            DOC_CACHE = ""
            for rel_file_path in DOCUMENTATION_FILES:
                with open(os.path.abspath(rel_file_path), 'r') as fin:
                    DOC_CACHE += fin.read() + "\n\n"
    
        return f"Systems Documentation:\n\n {DOC_CACHE}"
  • main.py:8-9 (helper)
    Global variables defining the list of documentation files to load and the cache for the loaded content, used by the tool handler.
    DOCUMENTATION_FILES = ("./docs/readme.md", "./docs/examples.md")
    DOC_CACHE = None
  • main.py:42-42 (registration)
    The @mcp.tool() decorator registers this function as an MCP tool.
    @mcp.tool()
Behavior3/5

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

No annotations are provided, so the description carries full burden. It discloses that the tool returns 'documentation and several examples of systems models' which describes output behavior. However, it doesn't mention important behavioral traits like whether this is a read-only operation, if it requires authentication, rate limits, or what happens if documentation isn't available. The description adds some behavioral context but leaves significant gaps.

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

Conciseness4/5

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

The description is appropriately concise with two sentences that each serve a purpose: the first states what the tool does and its purpose, the second describes the return value. It's front-loaded with the main action. There's minimal waste, though the second sentence could be integrated more smoothly.

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

Completeness4/5

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

Given the tool has 0 parameters, 100% schema coverage, and an output schema exists, the description is reasonably complete. It explains what the tool does and what it returns. The existence of an output schema means the description doesn't need to detail return values extensively. For a simple parameterless documentation loading tool, this provides adequate context.

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

Parameters4/5

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

The tool has 0 parameters with 100% schema description coverage, so the baseline is 4. The description appropriately doesn't waste space discussing non-existent parameters. No additional parameter information is needed or provided, which is correct for a parameterless tool.

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

Purpose3/5

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

The description states the tool 'loads systems documentation, examples, and specification details' which is a clear purpose, but it's somewhat vague about what exactly is being loaded. It distinguishes from the sibling tool 'run_systems_model' by focusing on loading documentation rather than executing models, but the distinction could be more explicit. The description doesn't specify verb+resource with precision.

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 description mentions the tool helps 'improve the models ability to generate specifications' which implies usage context, but provides no explicit guidance on when to use this tool versus alternatives. There's no mention of prerequisites, timing, or comparison with the sibling tool 'run_systems_model'. The usage context is implied rather than clearly stated.

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/lethain/systems-mcp'

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