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. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=true, and the description adds real behavioral value beyond that: the default-branch-head fallback and the exact return composition (totals plus per-file line coverage), which matters because no output schema exists. It omits pagination or response-size behavior, keeping it short of 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?

Two sentences, zero filler: the report scope is front-loaded and the REST endpoint reference is a compact trailing detail. Nothing is redundant with the title.

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 an 8-parameter read tool with no output schema, the description covers the default-branch behavior and the return contents while annotations carry the safety profile. It is nearly complete, missing only filtering interaction details (e.g. how flag/path/componentId narrow the report).

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% and all eight parameters, including the service enum, are documented in the schema. The description's only parameter note ('defaults to default branch head') duplicates the sha schema text, adding no meaning beyond the structured fields, so the baseline 3 applies.

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+resource (full coverage report for a commit) and clarifies the payload shape (totals plus per-file line coverage), which distinguishes it from the narrower siblings codecov_get_coverage_totals and codecov_get_file_coverage. It stops short of explicitly naming those alternatives, so it is clear but not fully differentiated.

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?

The description implies usage (a full commit-level report vs the totals/file siblings) and notes the sha default, but never states when to prefer this over codecov_get_coverage_totals or codecov_get_file_coverage, nor any prerequisites. Usage is inferable rather than spelled out.

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.