retrieveStatus

Single-target operation

Part of the Mcp Api MCP server. Enforce policies on this tool with Intercept, the open-source MCP proxy.

// WHEN AI AGENTS USE THIS TOOL

AI agents call retrieveStatus to retrieve information from Mcp Api without modifying any data. This is common in research, monitoring, and reporting workflows where the agent needs context before taking action. Because read operations don't change state, they are generally safe to allow without restrictions -- but you may still want rate limits to control API costs.

// WHY ENFORCE A POLICY ON RETRIEVESTATUS

Even though retrieveStatus only reads data, uncontrolled read access can leak sensitive information or rack up API costs. An agent caught in a retry loop could make thousands of calls per minute. A rate limit gives you a safety net without blocking legitimate use.

// RECOMMENDED POLICY

Read-only tools are safe to allow by default. No rate limit needed unless you want to control costs.

io-fusionauth-mcp-api.yaml

tools:
  retrieveStatus:
    rules:
      - action: allow

See the full Mcp Api policy for all 310 tools.

// DETAILS

Tool Name retrieveStatus

Category Read

MCP Server Mcp Api MCP Server

Risk Level Low

// MORE MCP API TOOLS

Destructive cancelActionWithId Destructive changePasswordWithId Destructive deleteAPIKeyWithId Destructive deleteApplicationRoleWithId Destructive deleteApplicationWithId Destructive deleteConnectorWithId Destructive deleteConsentWithId Destructive deleteEmailTemplateWithId

View all 310 tools →

// RELATED READING

// FAQ

What does the retrieveStatus tool do? +

Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics. OR Retrieves the FusionAuth system status. This request is anonymous and does not require an API key. When an API key is not provided the response will contain a single value in the JSON response indicating the current health check.. It is categorised as a Read tool in the Mcp Api MCP Server, which means it retrieves data without modifying state.

How do I enforce a policy on retrieveStatus? +

Add a rule in your Intercept YAML policy under the tools section for retrieveStatus. You can allow, deny, rate-limit, or validate arguments. Then run Intercept as a proxy in front of the Mcp Api MCP server.

What risk level is retrieveStatus? +

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

Can I rate-limit retrieveStatus? +

Yes. Add a rate_limit block to the retrieveStatus rule in your Intercept 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 retrieveStatus completely? +

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

retrieveStatus is provided by the Mcp Api MCP server (@fusionauth/mcp-api). Intercept sits as a proxy in front of this server to enforce policies before tool calls reach the server.

retrieveStatus

Enforce policies on Mcp Api