Skip to main content
Glama

Get branch

codecov_get_branch
Read-only

Get a single branch's detail, including its head commit's coverage totals. Codecov REST: GET /{service}/{owner_username}/repos/{repo_name}/branches/{name}/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoYesRepository name, e.g. 'codecov-api' (required).
ownerYesOwner username — the organization or user login on the git service, e.g. 'codecov' (required).
branchYesBranch name, e.g. 'main' (required).
serviceNoGit service provider — one of 'github' (default), 'gitlab', 'bitbucket', 'github_enterprise', 'gitlab_enterprise' or 'bitbucket_server'.github

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.5/5.0
Behavior3/5

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

The readOnlyHint annotation already declares this a safe read. The description adds modest value by noting the payload includes the head commit's coverage totals and by mapping to the REST endpoint, but it says nothing about auth requirements, pagination, or error behavior.

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 short sentences that are front-loaded with the purpose before the endpoint reference. The REST path line is slightly redundant given full schema coverage but remains informative and does not bloat the text.

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 and readOnlyHint covering the safety profile, the description is reasonably complete: it indicates what comes back (branch detail plus head-commit coverage totals). Minor gaps remain around return shape specifics, but nothing critical to correct invocation is missing.

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 four parameters (owner, repo, branch, service) are already documented in the schema. The REST path in the description mirrors these parameters without adding format or syntax beyond what the schema provides, 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 ('Get a single branch's detail') and clarifies scope with 'including its head commit's coverage totals.' The word 'single' implicitly distinguishes it from the sibling codecov_list_branches, though it does not name that alternative explicitly.

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 — fetch one branch when you have its name — but the description offers no explicit when-to-use guidance, no exclusions, and no pointer to codecov_list_branches or codecov_get_commit for adjacent needs.

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.