Skip to main content
Glama
Akshay1018

CodeDoc MCP Server

by Akshay1018

evaluate_and_refactor

Audit code health and generate optimized, refactored code to fix issues and maintain architectural integrity.

Instructions

Language-agnostic --- health audit AND generates optimized code.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
file_pathYes
custom_rulesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

The description only states that it generates optimized code, with no disclosure of side effects like file modification, reversibility, or required permissions. Since no annotations are provided, the description fails to convey crucial behavioral traits such as whether the tool is read-only or destructive.

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

Conciseness2/5

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

The description is a single fragment, under-specified and lacking proper structure. It is too terse to convey necessary information and reads as an incomplete note rather than a concise yet complete description.

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?

This is a complex tool with no annotations, and the description provides minimal context. It does not explain what the output contains despite an output schema being present, nor does it clarify its relationship with sibling tools. The agent cannot fully understand the tool's scope, return value, or side effects from this description alone.

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%, and the description does not mention either parameter. The purpose of 'custom_rules' is entirely unexplained, and even 'file_path' is only implicitly inferable from the tool's purpose. The description does nothing to compensate for the schema's lack of parameter details.

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 the tool performs a health audit and generates optimized code, which clearly identifies its primary actions. However, it does not differentiate from sibling tool 'refactor_and_optimize', and the term 'health audit' is somewhat vague without further elaboration.

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 provides no guidance on when to use this tool versus alternatives. It does not mention use cases, prerequisites, exclusions, or comparison with sibling tools such as 'refactor_and_optimize' or 'global_security_audit', leaving the agent without selection context.

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/Akshay1018/mcp-codedoc'

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