Skip to main content
Glama

get-code-smells

Returns code smell findings for a project (all vaults) or a single vault. Provide exactly one of project_id or vault_id. Requires full data access (a paid plan; verification-only plans are not included). Requires X-API-Key (existing users can generate an API key in the web app). If headers aren't supported, pass api_key in arguments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileNoFilter: substring match on file path.
limitNoMax results to return (default 50, max 200).
offsetNoNumber of results to skip, for pagination.
api_keyNoOptional API key for clients that cannot set X-API-Key headers.
issue_idNoReturn only this specific code smell id.
vault_idNoVault id (from create-code-vault or list_vaults). Returns data for this vault only.
issue_typeNoFilter: exact match on issue type.
project_idNoProject id (from create_project). Returns data aggregated across all vaults in the project.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does well: it discloses the plan gate (paid, verification-only excluded) and the auth path (X-API-Key, with an api_key argument fallback for header-less clients). It does not cover pagination behavior or rate limits, hence not a 5.

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?

Four short sentences, each front-loaded with its own concern: scope, scope-selection rule, plan gate, auth. No filler and no repetition.

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?

No output schema exists, but the description covers auth, plan entitlement, and the scope duality that an agent needs before calling. Return shape and pagination semantics are left to the schema fields, which is a minor gap for a findings-listing tool.

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

Parameters3/5

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

Schema description coverage is 100%, so each parameter is already documented. The description only restates the mutual-exclusion constraint already encoded in the schema's oneOf, adding no new syntax or format detail.

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?

States a specific verb+resource ('Returns code smell findings') and distinguishes the two scopes it serves: aggregated across all vaults in a project vs. a single vault. An agent immediately knows what this retrieves and at what granularity.

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?

Gives explicit selection rules for project_id vs vault_id ('exactly one of', with the scope each yields) and preconditions (full data access / paid plan, verification-only plans excluded). No mention of adjacent sibling tools such as get-security-issues or get-code-vault-results, so it stops short of full routing guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.