get_foreman_api_resource_docs

Fetches the documentation for given Foreman API resource.

Server Foreman MCP Server ofedoren/foreman-mcp-server
Category Read
Risk class Low
Parameters 00 required

What get_foreman_api_resource_docs does on Foreman MCP Server

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

Why get_foreman_api_resource_docs needs a policy

This tool retrieves and queries documentation, which is a read-only operation with no side effects. It does not create, modify, delete, or execute any infrastructure changes. The documentation fetch is informational only and carries minimal risk.

From the tool's definition Tool name 'get_foreman_api_resource_docs' and description 'Fetches the documentation for given Foreman API resource' indicate a retrieval operation that returns static documentation without modifying any state or executing operations.

Questions about get_foreman_api_resource_docs

What does the get_foreman_api_resource_docs tool do? +

Fetches the documentation for given Foreman API resource. It is categorised as a Read tool in the Foreman MCP Server MCP Server, which means it retrieves data without modifying state.

How do I enforce a policy on get_foreman_api_resource_docs? +

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

What risk level is get_foreman_api_resource_docs? +

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

Can I rate-limit get_foreman_api_resource_docs? +

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

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

get_foreman_api_resource_docs is provided by the Foreman MCP Server MCP server (ofedoren/foreman-mcp-server). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

// THE FULL RECORD

get_foreman_api_resource_docs is one line of Foreman MCP Server'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.