Skip to main content
Glama

dispersl_new_docs_agent

Generate file-by-file technical documentation for a code repository using agentic execution. Provide a repository URL to document each source file.

Instructions

Generate file by file technical documentation for a code repository using agentic execution

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
mcpNo
urlYes
modelNo
branchNo
contextNo
task_idNo
knowledgeNo
team_accessNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

C2.6/5.0
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 mentions 'agentic execution', which hints at asynchronous or task-based behavior, but does not describe side effects, authentication needs, whether a task is created, or what happens on completion.

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 a single front-loaded sentence with no wasted words. It is clear and direct, though its brevity is part of the wider completeness problem rather than a structural flaw.

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 8 undocumented parameters, a nested mcp object, no annotations, and no output schema, the description is too thin. It states the core purpose but omits behavior, parameter meaning, and invocation context needed to call this agent tool correctly.

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?

There are 8 parameters with 0% schema description coverage, and the description mentions none of them. It does not explain url, model, branch, context, task_id, knowledge, team_access, or the nested mcp object, leaving the agent with no semantic guidance beyond the purpose statement.

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 states a specific verb+resource: 'Generate file by file technical documentation' for a code repository. It clearly distinguishes this from sibling agent tools like dispersl_code_agent or dispersl_testing_agent by naming documentation generation as the task. It does not, however, explicitly mention when to choose it over those siblings.

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 offers no when-to-use guidance, no prerequisites, and no alternatives. It does not say whether this should be used after code changes, which repository URL forms are accepted, or how it relates to dispersl_plan_agent or dispersl_code_agent.

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