TrueNAS Middleware

Provides optimized documentation resources from the TrueNAS middleware repository to support efficient understanding of the codebase structure and APIs.

python

0

GitHub Stars

python

Language

2 months ago

First Indexed

3 weeks ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "sonicaj-tn_mcp": {
      "command": "python",
      "args": [
        "truenas_mcp_server.py"
      ]
    }
  }
}

You can run an MCP (Model Context Protocol) server that exposes TrueNAS middleware documentation resources for use by an MCP client. It helps you access organized, summarized resources focused on middleware structure, APIs, testing, and subsystems without overload. This guide shows practical steps to install, configure, and use the server from your environment.

How to use

Use the MCP server to query structured resources such as Overview, Plugins, API, Testing, and Subsystems. You can start a local server and connect to it from your MCP client to retrieve summarized documentation resources. The server exposes resources via MCP endpoints, allowing your client to request focused information and navigate documentation efficiently.

How to install

Prerequisites you need before installing:

Python 3.11 or newer installed on your system
pip available to install dependencies
Optional: Docker if you plan to run in containers

Option 1: Native Python (recommended)

python3.11 -m venv venv_tn_mcp
source venv_tn_mcp/bin/activate  # On Windows: venv_tn_mcp\Scripts\activate

pip install -r requirements.txt

./run_server.sh  # Or: python truenas_mcp_server.py

Option 2: Docker container

docker-compose build

docker-compose run --rm truenas-mcp

Configuration and start options

Choose one of the following local start methods to run the MCP server. You can select the Python-based start or the shell script start depending on your workflow.

Start using Python script (explicit command)

python truenas_mcp_server.py

Start using the provided shell script

./run_server.sh

Security and environment considerations

If you plan to expose the MCP server beyond your local machine, consider restricting access and using secure channels for MCP communication. Manage environment variables with care and keep any sensitive values out of source control.

Testing and maintenance notes

Run tests to ensure the MCP server behaves as expected in your environment. Use containerized tests when possible to maintain consistency across runs.

Available tools

scan_repository

Scans the middleware repository for CLAUDE.md files to identify documentation sources.

categorize_content

Organizes discovered documents into logical categories like Overview, Plugins, API, Testing, and Subsystems.

summarize_content

Generates concise summaries of content to minimize context overload while preserving key API signatures and patterns.

expose_resources

Exposes the processed documentation as MCP resources that an MCP client can query.