get_branch_overview

Get a comprehensive overview of a CodeUp branch including branch details, recent commits, and merge requests targeting the branch in one read-only call.

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

What get_branch_overview does on Yunxiao

AI agents call get_branch_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
mrLimit number Max merge requests returned. Defaults to 5.
mrState string Merge request state filter: opened, merged, or closed. Defaults to opened.
branchName string Yes Branch name, such as main or feature/demo.
commitLimit number Max commits 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.
includeCommits boolean Whether to include recent commits on the branch. Defaults to true.
organizationId string Yunxiao organization ID. When omitted, the server uses the user's default organization.
includeMergeRequests boolean Whether to include merge requests targeting the branch. Defaults to true.

Parameters from the server's own tool schema.

Why get_branch_overview needs a policy

This tool performs data retrieval only. It queries branch information, commit history, and merge request metadata from a version control system without modifying, executing, or deleting anything. The explicit 'read-only' designation and the nature of the returned data (overview, details, history) confirm it belongs in the Read category with low severity.

From the tool's definition Tool description explicitly states 'read-only call' and retrieves 'branch details, recent commits, and merge requests' — all query/view operations with no side effects.

Questions about get_branch_overview

What does the get_branch_overview tool do? +

Get a comprehensive overview of a CodeUp branch including branch details, recent commits, and merge requests targeting the branch 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_branch_overview accept? +

get_branch_overview accepts 8 parameters: mrLimit, mrState, branchName, commitLimit, repositoryId, includeCommits, organizationId, includeMergeRequests. Required: branchName, repositoryId. The full parameter table on this page comes from the server's own tool schema.

How do I enforce a policy on get_branch_overview? +

Register the Yunxiao MCP server in PolicyLayer and add a rule for get_branch_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_branch_overview? +

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

Can I rate-limit get_branch_overview? +

Yes. Add a rate_limit block to the get_branch_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_branch_overview completely? +

Set action: deny in the PolicyLayer policy for get_branch_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_branch_overview? +

get_branch_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.