Skip to main content
Glama
Akshay1018

CodeDoc MCP Server

by Akshay1018

global_security_audit

Scan your entire project for secrets, keys, and vulnerabilities to avoid exposing sensitive data when pushing to GitHub or GitLab.

Instructions

Scans the ENTIRE project for secrets, keys, and vulnerabilities. Use this before pushing code to GitHub/GitLab.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

With no annotations provided, the description carries the full burden. It discloses the scope ('ENTIRE project') and focus, but does not state whether the scan is read-only, if it modifies anything, or what it does with findings. The word 'scans' implies non-destructive but it is not explicit, leaving a gap.

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 two sentences, front-loaded with the action, and ends with a clear usage trigger. Every word earns its place with no fluff.

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?

For a zero-parameter tool with an output schema, the description gives enough to know what it does and when to use it. It does not dwell on limitations or result handling, but this is not critical given the schema. Slight ambiguity with sibling tools prevents a 5.

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 zero parameters, so the description is not expected to explain parameters. The schema covers all 0 parameters, and the baseline for 0 params is 4.

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 action ('Scans the ENTIRE project') and identifies the resource and scope (secrets, keys, vulnerabilities). It is clear but does not explicitly differentiate from sibling tools like guardian_scan or scan_project_files, warranting a 4 rather than a 5.

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

Usage Guidelines4/5

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

The description gives explicit usage guidance: 'Use this before pushing code to GitHub/GitLab.' This is clear context, but it does not mention alternatives or exclusions, so it falls short of a 5.

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