Summarize Projex work items by category for one project with samples and pagination totals. This is ideal for dashboards and overviews. For detailed searching with complex filters, use search_workitems instead.
AI agents call get_project_workitem_summary 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 |
|---|---|---|---|
tag | string | — | Comma-separated tag IDs applied to every category. |
sort | string | — | Sort direction: asc or desc. |
status | string | — | Comma-separated status IDs applied to every category. |
creator | string | — | Comma-separated creator user IDs applied to every category. |
orderBy | string | — | Sort field. Defaults are controlled by Yunxiao. |
subject | string | — | Subject contains filter applied to every category. |
projectId | string | Yes | Project ID. Use search_projects to discover valid IDs. |
assignedTo | string | — | Comma-separated assignee user IDs applied to every category. |
categories | string | — | Comma-separated work item categories. Defaults to Req,Task,Bug,Risk. |
conditions | string | — | Advanced conditions JSON string applied to every category. Overrides simple filters. |
sampleLimit | number | — | Samples returned per category. Defaults to 5, clamped to 0-200. |
organizationId | string | — | Yunxiao organization ID. When omitted, the server uses the user's default organization. |
Parameters from the server's own tool schema.
This tool retrieves and aggregates summary data about work items grouped by category, with pagination support. It performs no writes, deletes, or code execution—purely a read operation that returns a dashboard/overview summary of existing project data.
From the tool's definition Tool description states it 'Summarize[s]' work items and is 'ideal for dashboards and overviews', indicating data retrieval.
Risk signalsHigh parameter count (12 properties)
Attacks that exploit this kind of access
Summarize Projex work items by category for one project with samples and pagination totals. This is ideal for dashboards and overviews. For detailed searching with complex filters, use search_workitems instead. It is categorised as a Read tool in the Yunxiao MCP Server, which means it retrieves data without modifying state.
get_project_workitem_summary accepts 12 parameters: tag, sort, status, creator, orderBy, subject, projectId, assignedTo, categories, conditions, sampleLimit, organizationId. 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_workitem_summary: 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_workitem_summary 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_workitem_summary 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_workitem_summary. 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_workitem_summary 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 →