Get API documentation (versioning, models, patterns, best practices)
AI agents call truenas_api_docs to retrieve information from TrueNAS Middleware MCP Server without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
This tool retrieves and queries existing API documentation without modifying, executing, or deleting any data. It has no side effects beyond returning information to the user. The server's stated purpose is to 'expose categorized resources' for understanding codebase structure, confirming a read-only documentation access pattern.
From the tool's definition Tool name 'truenas_api_docs' and description 'Get API documentation (versioning, models, patterns, best practices)' indicate retrieval of documentation and reference information.
Attacks that exploit this kind of access
Get API documentation (versioning, models, patterns, best practices). It is categorised as a Read tool in the TrueNAS Middleware MCP Server MCP Server, which means it retrieves data without modifying state.
Register the TrueNAS Middleware MCP Server MCP server in PolicyLayer and add a rule for truenas_api_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 TrueNAS Middleware MCP Server. Nothing to install.
truenas_api_docs is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the truenas_api_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.
Set action: deny in the PolicyLayer policy for truenas_api_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.
truenas_api_docs is provided by the TrueNAS Middleware MCP Server MCP server (sonicaj/tn_mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the 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 →