get_resource_instance

Get an AppStack resource instance by name within a resource pool. Resource instances represent individual machines or hosts.

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

What get_resource_instance does on Yunxiao

AI agents call get_resource_instance 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
poolName string Yes Resource pool name. Use list_resource_instances to discover valid pool names.
instanceName string Yes Resource instance name. Use list_resource_instances to discover valid instance names.
organizationId string Yunxiao organization ID. When omitted, the server uses the user's default organization.

Parameters from the server's own tool schema.

Why get_resource_instance needs a policy

This tool retrieves information about individual machines or hosts within a resource pool. It performs a lookup/query operation with no side effects—it does not create, modify, delete, or execute anything. The blast radius of misuse is minimal since it only exposes existing infrastructure metadata.

From the tool's definition Tool name 'get_resource_instance' and description 'Get an AppStack resource instance by name' indicate a retrieval operation. The phrase 'Get...by name' is a characteristic read pattern that queries existing data without modification.

Questions about get_resource_instance

What does the get_resource_instance tool do? +

Get an AppStack resource instance by name within a resource pool. Resource instances represent individual machines or hosts. It is categorised as a Read tool in the Yunxiao MCP Server, which means it retrieves data without modifying state.

What parameters does get_resource_instance accept? +

get_resource_instance accepts 3 parameters: poolName, instanceName, organizationId. Required: poolName, instanceName. The full parameter table on this page comes from the server's own tool schema.

How do I enforce a policy on get_resource_instance? +

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

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

Can I rate-limit get_resource_instance? +

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

Set action: deny in the PolicyLayer policy for get_resource_instance. 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_resource_instance? +

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