get_commit_overview

Get a comprehensive overview of a CodeUp commit including commit details, commit statuses, and check runs in one read-only call.

Server Yunxiao @futuretea/yunxiao-mcp-server
Category Read
Risk class Low
Parameters 72 required

What get_commit_overview does on Yunxiao

AI agents call get_commit_overview to retrieve information from Yunxiao without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.

ParameterTypeRequiredDescription
sha string Yes Commit SHA (full 40-character hash). Use list_commits to discover valid SHAs.
statusLimit number Max commit statuses returned. Defaults to 5.
repositoryId string Yes Repository ID (numeric ID or full path like org/repo). Use list_repositories to find the repository ID.
checkRunLimit number Max check runs returned. Defaults to 5.
organizationId string Yunxiao organization ID. When omitted, the server uses the user's default organization.
includeStatuses boolean Whether to include commit statuses. Defaults to true.
includeCheckRuns boolean Whether to include check runs. Defaults to true.

Parameters from the server's own tool schema.

Why get_commit_overview needs a policy

This tool performs a query operation that retrieves and aggregates existing data about a commit from the CodeUp system. The explicit 'read-only' designation confirms it has no side effects, making it a Read category risk with low severity.

From the tool's definition Tool description explicitly states 'one read-only call' and retrieves 'commit details, commit statuses, and check runs' without modification or side effects.

Questions about get_commit_overview

What does the get_commit_overview tool do? +

Get a comprehensive overview of a CodeUp commit including commit details, commit statuses, and check runs in one read-only call. It is categorised as a Read tool in the Yunxiao MCP Server, which means it retrieves data without modifying state.

What parameters does get_commit_overview accept? +

get_commit_overview accepts 7 parameters: sha, statusLimit, repositoryId, checkRunLimit, organizationId, includeStatuses, includeCheckRuns. Required: sha, repositoryId. The full parameter table on this page comes from the server's own tool schema.

How do I enforce a policy on get_commit_overview? +

Register the Yunxiao MCP server in PolicyLayer and add a rule for get_commit_overview: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Yunxiao. Nothing to install.

What risk level is get_commit_overview? +

get_commit_overview is a Read tool with low risk. Read-only tools are generally safe to allow by default.

Can I rate-limit get_commit_overview? +

Yes. Add a rate_limit block to the get_commit_overview rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.

How do I block get_commit_overview completely? +

Set action: deny in the PolicyLayer policy for get_commit_overview. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.

What MCP server provides get_commit_overview? +

get_commit_overview is provided by the Yunxiao MCP server (@futuretea/yunxiao-mcp-server). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

// LOOK UP ANOTHER SERVER

Every MCP server has a record like this.

Type a name, get the same breakdown: verified identity, auth posture, risk grade, capabilities, recommended policy.

Teams ship this data inside their own products. See what a licence covers →

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.