AI agents call get_project_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.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | number | — | Page number for paged list sections. Defaults to 1. |
status | string | — | Comma-separated statuses for sprint, milestone, and version sections when activeOnly is true. Defaults to TODO,DOING. |
perPage | number | — | Page size for paged list sections. Defaults to 20. |
projectId | string | Yes | Project ID. Use search_projects to discover valid IDs. |
activeOnly | boolean | — | Whether sprint, milestone, and version sections use the status filter. Defaults to true. |
includeLabels | boolean | — | Whether to include labels. Defaults to true. |
includeMembers | boolean | — | Whether to include project members. Defaults to true. |
includeSprints | boolean | — | Whether to include sprints. Defaults to true. |
organizationId | string | — | Yunxiao organization ID. When omitted, the server uses the user's default organization. |
includeVersions | boolean | — | Whether to include versions. Defaults to true. |
includeMilestones | boolean | — | Whether to include milestones. Defaults to true. |
Parameters from the server's own tool schema.
This tool queries and retrieves project overview information without side effects. It is clearly a read operation designed for exploration and information gathering, posing minimal risk if misused by an AI agent.
From the tool's definition Tool description explicitly states 'read-only call' and retrieves project metadata (members, sprints, milestones, versions, labels). No modification, deletion, execution, or financial operation is performed.
Risk signalsHigh parameter count (11 properties)
Attacks that exploit this kind of access
Get a compact Projex project overview with members, sprints, milestones, versions, and labels in one read-only call. This is the best starting point when exploring a new project. It is categorised as a Read tool in the Yunxiao MCP Server, which means it retrieves data without modifying state.
get_project_overview accepts 11 parameters: page, status, perPage, projectId, activeOnly, includeLabels, includeMembers, includeSprints, organizationId, includeVersions, includeMilestones. Required: projectId. The full parameter table on this page comes from the server's own tool schema.
Register the Yunxiao MCP server in PolicyLayer and add a rule for get_project_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.
get_project_overview is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the get_project_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.
Set action: deny in the PolicyLayer policy for get_project_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.
get_project_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.
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 →