Skip to main content
Glama

github_checks_list_for_ref

List all check runs for a specific Git reference (branch, tag, or commit SHA) in a repository. Filter by check name, status, or completion time to monitor CI/CD results.

Instructions

List check runs for a Git reference

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ownerYesowner
repoYesrepo
refYesref
check_nameNoReturns check runs with the specified `name`.
statusNoReturns check runs with the specified `status`.
filterNoFilters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.
per_pageNoThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
pageNoThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
app_idNoapp_id
Behavior2/5

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

The description fails to disclose any behavioral traits such as read-only nature, pagination, or result structure. With no annotations, the burden is on the description, but it only provides a verb-noun phrase. Key behavioral aspects like the effect of 'filter', 'status', and 'per_page' parameters are not explained.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is very short (one sentence), which is concise but at the cost of completeness. It lacks any structured information such as examples or edge cases. While not verbose, it does not fully serve its purpose with such minimal content.

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

Completeness2/5

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

Given the 9 parameters, no output schema, and many sibling tools, the description is insufficient. It does not mention pagination, common use cases, or how to interpret results. The agent is left with significant gaps in understanding the tool's behavior and output.

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 coverage is 100%, so baseline is 3. The description adds no additional meaning beyond the schema. It does not explain the purpose of parameters like 'check_name', 'status', or 'filter' despite their descriptions being in the schema. The description does not enhance understanding.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action (list) and resource (check runs) and scope (for a Git reference). However, it does not differentiate from sibling tools like github_checks_list_for_suite, which also lists check runs but for a specific suite. Without distinction, an agent may struggle to choose the correct 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?

No guidance is provided on when to use this tool versus alternatives. The description does not mention any prerequisites, context, or exclusionary conditions. An agent has no hints about suitability over other list-related check tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Eyalm321/github-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server