Skip to main content
Glama

Get coverage report

codecov_get_coverage_report
Read-only

Full coverage report for a commit (defaults to default branch head) — totals plus per-file line coverage. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/report/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shaNoCommit SHA to report on (defaults to the default branch head).
flagNoRestrict the report to a coverage flag.
pathNoRestrict the report to a file or directory path prefix.
repoYesRepository name, e.g. 'codecov-api' (required).
ownerYesOwner username — the organization or user login on the git service, e.g. 'codecov' (required).
branchNoBranch whose head to report on.
serviceNoGit service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'.github
componentIdNoRestrict the report to a component (maps to `component_id`).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

readOnlyHint=true already declares the safety profile, and the description adds value beyond it: the default-branch-head fallback, the return shape (totals plus per-file line coverage), and the underlying REST route implying a GET. It does not mention pagination or size limits, so it is not a full 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?

Two compact sentences with the scope statement front-loaded and the endpoint reference secondary. No wasted language.

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?

With no output schema, the description usefully discloses what is returned (totals and per-file line coverage) and the default target commit. Combined with the read-only annotation and fully documented schema, this is nearly complete, though it omits response size/pagination expectations.

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 the schema already explains all 8 parameters. The description only restates the sha/branch default behavior without adding format or filtering semantics beyond what the schema provides, matching the baseline 3.

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?

States a specific verb and resource ('Full coverage report for a commit') and clarifies scope as 'totals plus per-file line coverage'. This implicitly contrasts with codecov_get_coverage_totals and codecov_get_file_coverage, but no sibling is named explicitly, so it stops short of 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 Guidelines3/5

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

Usage is only implied: the phrase 'Full coverage report' plus the default-branch-head behavior suggests a comprehensive view versus narrower siblings. There is no explicit when-to-use, when-not-to-use, or named alternative among the many similarly-named reporting tools.

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.