get_organization_overview

Get a comprehensive overview of a Yunxiao organization including basic info, departments, members, groups, and roles in one read-only call.

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

What get_organization_overview does on Yunxiao

AI agents call get_organization_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
groupLimit number Maximum groups to include in the overview. Defaults to 5. Set to 0 to exclude.
memberLimit number Maximum members to include in the overview. Defaults to 5. Set to 0 to exclude.
includeRoles boolean Whether to include roles list. Defaults to true.
includeGroups boolean Whether to include groups list. Defaults to true.
includeMembers boolean Whether to include members list. Defaults to true.
organizationId string Yunxiao organization ID. When omitted, the server uses the user's default organization.
departmentLimit number Maximum departments to include in the overview. Defaults to 5. Set to 0 to exclude.
includeDepartments boolean Whether to include departments list. Defaults to true.

Parameters from the server's own tool schema.

Why get_organization_overview needs a policy

This tool queries and retrieves organizational data without creating, modifying, deleting, or executing operations. The explicit 'read-only' designation confirms it has no side effects. Blast radius is minimal—exposure of organizational structure metadata poses low risk compared to write, execute, or destructive operations.

From the tool's definition Tool description explicitly states 'read-only call' and retrieves organizational metadata (basic info, departments, members, groups, roles) without modification or side effects.

Questions about get_organization_overview

What does the get_organization_overview tool do? +

Get a comprehensive overview of a Yunxiao organization including basic info, departments, members, groups, and roles 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_organization_overview accept? +

get_organization_overview accepts 8 parameters: groupLimit, memberLimit, includeRoles, includeGroups, includeMembers, organizationId, departmentLimit, includeDepartments. The full parameter table on this page comes from the server's own tool schema.

How do I enforce a policy on get_organization_overview? +

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

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

Can I rate-limit get_organization_overview? +

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

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

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