guide

Load the domain guide for a backend capability — the rules, conventions, and gotchas for a plugin area (database, type, bindings, actionflow, api, tpa, zai, component, permissions, payments, logs, agent). Returns guidance for the loaded project’s type-system state. Call before editing an unfamili...

Server Zion zion-mcp
Category Read
Risk class Low
Parameters 21 required

What guide does on Zion

AI agents call guide to retrieve information from Zion without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.

ParameterTypeRequiredDescription
plugin string Yes
projectExId string

Parameters from the server's own tool schema.

Why guide needs a policy

The tool only reads and returns guidance/documentation about backend capabilities. It does not create, modify, delete, or execute anything. It is a reference lookup tool to be called before editing, indicating it is a read-only operation.

From the tool's definition 'Load the domain guide' and 'Returns guidance for the loaded project's type-system state' — purely retrieves documentation/rules/conventions with no side effects

Questions about guide

What does the guide tool do? +

Load the domain guide for a backend capability — the rules, conventions, and gotchas for a plugin area (database, type, bindings, actionflow, api, tpa, zai, component, permissions, payments, logs, agent). Returns guidance for the loaded project’s type-system state. Call before editing an unfamiliar area, or when a meta-tool call is rejected. It is categorised as a Read tool in the Zion MCP Server, which means it retrieves data without modifying state.

What parameters does guide accept? +

guide accepts 2 parameters: plugin, projectExId. Required: plugin. The full parameter table on this page comes from the server's own tool schema.

How do I enforce a policy on guide? +

Register the Zion MCP server in PolicyLayer and add a rule for guide: 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 Zion. Nothing to install.

What risk level is guide? +

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

Can I rate-limit guide? +

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

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

guide is provided by the Zion MCP server (zion-mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

// THE FULL RECORD

guide is one line of Zion's registry record.

The record carries the whole server: verified identity, auth posture, risk grade, every tool classified, recommended policy — re-checked continuously.

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.