truenas_subsystem_docs

Get documentation for specific TrueNAS subsystems (alert, alembic, etc.)

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

What truenas_subsystem_docs does on TrueNAS Middleware MCP Server

AI agents call truenas_subsystem_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_subsystem_docs needs a policy

This tool retrieves and queries documentation resources for TrueNAS subsystems. It performs a read-only operation with no side effects, no code execution, no data modification, and no destructive actions. The term 'Get' in the description confirms it is a retrieval operation. The low severity reflects minimal risk from documentation access alone.

From the tool's definition Tool name 'truenas_subsystem_docs' and description 'Get documentation for specific TrueNAS subsystems' indicate retrieval of existing documentation without modification or execution capabilities.

Questions about truenas_subsystem_docs

What does the truenas_subsystem_docs tool do? +

Get documentation for specific TrueNAS subsystems (alert, alembic, etc.). 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_subsystem_docs? +

Register the TrueNAS Middleware MCP Server MCP server in PolicyLayer and add a rule for truenas_subsystem_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_subsystem_docs? +

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

Can I rate-limit truenas_subsystem_docs? +

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

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

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