Skip to main content
Glama

Get report tree

codecov_get_report_tree
Read-only

Coverage report as a file/directory tree for a commit (defaults to default branch head). Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/report/tree.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shaNoCommit SHA to report on (defaults to the default branch head).
flagNoRestrict the tree to a coverage flag.
pathNoRestrict the tree to a directory path prefix.
repoYesRepository name, e.g. 'codecov-api' (required).
depthNoMaximum tree depth to return.
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 tree 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

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds genuinely useful behavior beyond that: the default targeting of the default branch head, and the underlying REST endpoint. It omits other behavioral traits such as pagination/truncation of large trees or what the depth default is.

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?

Two tight sentences, front-loaded with the core purpose before the default and endpoint details. The REST endpoint restatement is optional but brief enough not to be wasteful.

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 read-only tree-fetch tool with full schema coverage and no output schema, the description covers purpose and default targeting but says nothing about the shape or size of the returned tree, and gives no guidance on the nine parameters' combined behavior. Adequate, but with visible gaps for a 9-parameter 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 all nine parameters are already documented in the schema — the baseline here is 3. The description only restates the sha/branch default behavior already present in the parameter descriptions, adding no syntax or interaction details (e.g., sha vs branch precedence).

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+resource ('Coverage report as a file/directory tree for a commit'), which clearly separates it from flat siblings like codecov_get_coverage_report or codecov_get_file_coverage. It does not, however, explicitly name or contrast any sibling tool.

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 implied by what the tool returns (a hierarchical tree), and the parenthetical clarifies the default target (default branch head). There is no explicit when-to-use/when-not guidance, no mention of when to prefer codecov_get_file_coverage or codecov_get_coverage_report instead.

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.