Skip to main content
Glama

get_sqale_metrics

Calculate SQALE technical debt metrics, including remediation time, debt ratio, and rating, for a project to assess and prioritize code debt.

Instructions

Get SQALE technical debt metrics including remediation time, debt ratio, and rating.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "get_sqale_metrics"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesAbsolute path to the project root directory
developmentTimeNoOptional: estimated development time in hours for debt ratio calculation

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.1

TDQS

B3.2/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full disclosure burden. It usefully enumerates the metrics returned (remediation time, debt ratio, rating), which tells the agent what to expect, but it says nothing about whether analysis must be run first, whether the tool triggers computation, or how long a scan might take.

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?

A single front-loaded sentence with no filler; the output metrics are listed in the most useful position. It is not padded, though it is thin enough that brevity comes at the cost of guidance.

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

Completeness3/5

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

For a two-parameter read-only analysis tool with full schema coverage but no annotations or output schema, the description adequately covers what is returned. It falls short on preconditions (must the project already be analyzed?) and on differentiation from the debt-summary sibling.

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 both parameters (path and developmentTime) are already fully documented in the schema. The description only implicitly links 'debt ratio' to the optional developmentTime input and adds no format or default guidance beyond the schema.

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 (Get) and resource (SQALE technical debt metrics) and enumerates the returned values: remediation time, debt ratio, and rating. It is clear on its own, but it never distinguishes itself from the sibling get_debt_summary, which sounds like an overlapping debt-metrics tool.

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?

There is no statement about when to use this tool versus alternatives such as get_debt_summary, or what prerequisite state the project must be in. The mention of 'SQALE' implies a methodology-specific variant, but that implication is left entirely for the agent to infer.

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