Skip to main content
Glama

get_combined_status

Retrieve the combined status of a GitHub commit to check CI/CD pipeline results and deployment readiness for a specific repository reference.

Instructions

Get the combined status for a commit

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ownerYesRepository owner (username or organization)
repoYesRepository name
refYesThe ref (SHA, branch name, or tag name) to get the combined status for

Implementation Reference

  • Core handler function that executes the tool logic: fetches combined commit status from GitHub API and parses with Zod schema.
    export async function getCombinedStatus(
      github_pat: string,
      owner: string,
      repo: string,
      ref: string
    ): Promise<z.infer<typeof CombinedStatusResponseSchema>> {
      const response = await githubRequest(
        github_pat,
        `https://api.github.com/repos/${owner}/${repo}/commits/${ref}/status`
      );
      
      return CombinedStatusResponseSchema.parse(response);
    }
  • Input schemas: public schema for tool registration and internal schema (with PAT) for parsing tool call arguments.
    export const GetCombinedStatusSchema = z.object({
      owner: z.string().describe("Repository owner (username or organization)"),
      repo: z.string().describe("Repository name"),
      ref: z.string().describe("The ref (SHA, branch name, or tag name) to get the combined status for")
    });
    
    export const _GetCombinedStatusSchema = GetCombinedStatusSchema.extend({
      github_pat: z.string().describe("GitHub Personal Access Token"),
    });
  • Output schema used to validate and type the GitHub combined status API response.
    export const CombinedStatusResponseSchema = z.object({
      state: z.string(),
      statuses: z.array(CommitStatusSchema),
      sha: z.string(),
      total_count: z.number(),
      repository: z.object({
        id: z.number(),
        name: z.string(),
        full_name: z.string(),
        owner: z.any(),
      }),
    });
  • src/index.ts:221-225 (registration)
    Tool registration in the MCP server's ListTools response, defining name, description, and input schema.
    {
      name: "get_combined_status",
      description: "Get the combined status for a commit",
      inputSchema: zodToJsonSchema(statuses.GetCombinedStatusSchema),
    },
  • MCP CallTool handler case: parses arguments and delegates to the core getCombinedStatus implementation.
    case "get_combined_status": {
      const args = statuses._GetCombinedStatusSchema.parse(params.arguments);
      const { github_pat, owner, repo, ref } = args;
      const result = await statuses.getCombinedStatus(github_pat, owner, repo, ref);
      return {
        content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
      };
    }
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure but offers minimal insight. It doesn't mention whether this is a read-only operation, what permissions are required, how rate limits apply, or what the output format might be. The description fails to compensate for the lack of annotations.

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?

The description is a single, efficient sentence with zero wasted words. It's front-loaded with the core action and resource, making it easy to parse quickly. Every word earns its place by directly contributing to understanding the tool's purpose.

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 lack of annotations and output schema, the description is incomplete. It doesn't explain what 'combined status' means in practice, what data is returned, or any behavioral traits like error handling. For a tool with three parameters and no structured output documentation, this leaves significant gaps for an agent.

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 fully documents the three parameters (owner, repo, ref). The description adds no additional meaning beyond what's in the schema, such as clarifying what 'combined status' entails or how the ref parameter interacts with it. Baseline 3 is appropriate when the schema does the heavy lifting.

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 clearly states the action ('Get') and target resource ('combined status for a commit'), making the purpose immediately understandable. It doesn't distinguish from sibling tools like 'get_commit_statuses' which might retrieve individual statuses rather than a combined view, but the core functionality is well-defined.

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 like 'get_commit_statuses' or other status-related tools. The description lacks context about prerequisites, typical use cases, or any exclusions, leaving the agent to infer usage from the name alone.

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/MissionSquad/mcp-github'

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