get_work_item_type_overview

Get a comprehensive overview of a Projex work item type including basic info, field configuration, and workflow in one read-only call. Use this to understand the schema and lifecycle of a specific work item type.

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

What get_work_item_type_overview does on Yunxiao

AI agents call get_work_item_type_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
projectId string Yes Project ID. Use search_projects to discover valid IDs.
organizationId string Yunxiao organization ID. When omitted, the server uses the user's default organization.
workItemTypeId string Yes Work item type ID (numeric string). Use list_work_item_types to find available types.
includeWorkflow boolean Whether to include workflow metadata. Defaults to true.
includeFieldConfig boolean Whether to include field configuration. Defaults to true.

Parameters from the server's own tool schema.

Why get_work_item_type_overview needs a policy

This tool only retrieves and queries metadata about work item type configuration, workflow, and schema. It performs no modifications, deletions, code execution, or financial operations. The explicit mention of 'read-only' and the action of 'get' and 'understand' (gathering information) clearly position this as a Read category tool with low severity.

From the tool's definition Tool description explicitly states 'read-only call' and retrieves 'comprehensive overview' and 'schema and lifecycle' of a work item type—purely informational retrieval with no side effects.

Questions about get_work_item_type_overview

What does the get_work_item_type_overview tool do? +

Get a comprehensive overview of a Projex work item type including basic info, field configuration, and workflow in one read-only call. Use this to understand the schema and lifecycle of a specific work item type. It is categorised as a Read tool in the Yunxiao MCP Server, which means it retrieves data without modifying state.

What parameters does get_work_item_type_overview accept? +

get_work_item_type_overview accepts 5 parameters: projectId, organizationId, workItemTypeId, includeWorkflow, includeFieldConfig. Required: projectId, workItemTypeId. The full parameter table on this page comes from the server's own tool schema.

How do I enforce a policy on get_work_item_type_overview? +

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

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

Can I rate-limit get_work_item_type_overview? +

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

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

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