truenas_plugin_docs

Get documentation for TrueNAS plugins (service types, patterns, specific plugins)

Server TrueNAS Middleware MCP Server sonicaj/tn_mcp
Category Read
Risk class Low
Parameters 00 required

What truenas_plugin_docs does on TrueNAS Middleware MCP Server

AI agents call truenas_plugin_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.

Why truenas_plugin_docs needs a policy

This tool retrieves and queries plugin documentation and patterns from the TrueNAS codebase. There is no indication it modifies data, executes code, deletes resources, or commits financial obligations. It is a passive documentation lookup mechanism intended to help AI assistants understand codebase structure. The low severity reflects minimal blast radius—documentation retrieval poses no direct risk even if misused.

From the tool's definition Tool description states 'Get documentation for TrueNAS plugins' — a retrieval operation. Sibling tools like 'truenas_search_docs', 'truenas_api_docs', and 'truenas_overview' reinforce this server's Read-only nature (documentation and pattern exposure without…

Questions about truenas_plugin_docs

What does the truenas_plugin_docs tool do? +

Get documentation for TrueNAS plugins (service types, patterns, specific plugins). It is categorised as a Read tool in the TrueNAS Middleware MCP Server MCP Server, which means it retrieves data without modifying state.

How do I enforce a policy on truenas_plugin_docs? +

Register the TrueNAS Middleware MCP Server MCP server in PolicyLayer and add a rule for truenas_plugin_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.

What risk level is truenas_plugin_docs? +

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

Can I rate-limit truenas_plugin_docs? +

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

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

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

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