Skip to main content
Glama
rodlunt

engineering-audit

by rodlunt

begin_run

Initiate a new engineering audit run, creating an output directory for the audit results. Provide metadata like repository, commit, and assistant to begin the audit process.

Instructions

Start a fresh audit run and create its output directory.

    assistant/model/repo_name/repo_commit/started are supplied by the
    calling agent; tool_version defaults to the installed package version
    if omitted; environment is optional free-form metadata. repo_dir is
    the path to the repository being audited, on disk; it is optional,
    but file_issues needs it to detect the GitHub repository to file
    against, unless a repo is given explicitly on that call instead.
    Calling this twice without finishing the first run (via
    render_report) is an error, since it would silently discard whatever
    domain results have already been recorded; pass replace=True to
    explicitly discard the in-progress run and start over.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modelYes
replaceNo
startedYes
repo_dirNo
assistantYes
repo_nameYes
output_dirYes
environmentNo
repo_commitYes
tool_versionNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

With no annotations, the description carries the full transparency burden. It discloses key behaviors such as the error condition for double invocation, the silent discard risk, and the default behavior for tool_version. However, it does not fully describe all side effects like handling of existing output directories or auth requirements, so a 4 is appropriate.

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 well-structured, front-loaded with a clear one-line purpose, followed by parameter explanations and ending with an error condition. Every sentence adds valuable information without fluff, making it dense but appropriately concise for a tool with 10 parameters.

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

Completeness5/5

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

Given the tool's complexity (10 params, no annotations, output schema present), the description covers the essential context: purpose, parameter semantics, relationships to other tools (file_issues, render_report), and error recovery. The output schema exists so return values need not be described. The description is sufficiently complete for an agent to invoke the tool correctly.

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

Parameters5/5

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

Despite 0% schema description coverage, the description explicitly explains the meaning and usage of nearly all parameters: assistant/model/repo_name/repo_commit/started are identified as caller-supplied, tool_version defaults, environment is optional metadata, repo_dir's role for file_issues, and replace's effect. This comprehensively compensates for the schema's lack of descriptions.

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 'Start a fresh audit run and create its output directory', which is a specific verb+resource action. It distinguishes the tool from siblings like run_status and render_report by focusing on the initialization aspect of an audit run.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage context: it explains when to provide repo_dir (needed for file_issues), warns against calling twice without finishing via render_report, and instructs to pass replace=True to discard an in-progress run. This gives clear when-to-use and when-not-to-use guidance alongside alternatives.

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/rodlunt/engineering-audit'

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