TrueNAS Middleware MCP Server

by sonicaj

Not rated
GitHub

About

Accesses optimized documentation from the TrueNAS middleware repository to understand its codebase and APIs.

Details

Author
sonicaj
Categories
Developer Tools, Knowledge Base, API, Other, File Management

Setup

Install TrueNAS Middleware MCP Server in your MCP client (Claude Desktop, Cursor, Windsurf, and others).

Repository: https://github.com/sonicaj/tn_mcp

Follow the installation instructions in the repository README, then restart your MCP client.

Accesses optimized documentation from the TrueNAS middleware repository to understand its codebase and APIs.

This MCP (Model Context Protocol) server provides optimized documentation resources from the TrueNAS middleware repository to Code Claude, helping it understand the codebase structure and APIs without context overload.
- For Code Claude Integration: SeeINTEGRATION_GUIDE.md
- For Usage in Code Claude: See
QUICK_REFERENCE.md
- For Adding Documentation: See
DOCUMENTATION_GUIDE.md
- For Plugin Doc Template: See
PLUGIN_DOCUMENTATION_TEMPLATE.md
- For Development Plans: See
ACTION_PLAN.md

- Automatically discovers and processes all CLAUDE.md files in the middleware repository
- Organizes documentation into logical categories (Overview, Plugins, API, Testing, Subsystems)
- Provides concise, focused resources to avoid context overload
- Implements intelligent content summarization
- Create and activate the virtual environment:

python3.11 -m venv venv_tn_mcp source venv_tn_mcp/bin/activate # On Windows: venv_tn_mcp\Scripts\activate
./run_server.sh # Or: python truenas_mcp_server.py

The server provides the following types of resources:

- truenas://overview- High-level middleware architecture
- truenas://development/guidelines- Development best practices

- truenas://plugins/service-types- Guide to service base classes
- truenas://plugins/patterns- Common plugin patterns
- truenas://plugins/categories- Categorized plugin list
- truenas://plugins/{plugin_name}- Specific plugin documentation

- truenas://api/versioning- API versioning guide
- truenas://api/models- Pydantic model patterns

- truenas://testing/overview- Testing guide
- truenas://testing/patterns- Common testing patterns

- truenas://subsystems/{name}- Documentation for specific subsystems

SeeINTEGRATION_GUIDE.mdfor detailed setup instructions.

Quick Config(add toclaude_desktop_config.json):

{ "mcpServers": { "truenas-docs": { "command": "/path/to/venv_tn_mcp/bin/python", "args": ["/path/to/tn_mcp/truenas_mcp_server.py"] } } }

- The server scans the middleware repository for all CLAUDE.md files
- Each file is processed and categorized based on its location
- Content is intelligently summarized to reduce context size
- Resources are exposed via MCP protocol for Code Claude to query

- Extracts key sections from documentation
- Limits code examples to essential ones
- Focuses on API signatures and patterns rather than full implementations
- Groups related information into logical resources

Tests are run using Docker to ensure a consistent environment.

docker-compose run --rm truenas-mcp-test
docker-compose run --rm truenas-mcp-test pytest tests/test_truenas_mcp_tools_server.py -v
docker-compose run --rm truenas-mcp-test pytest --cov=. --cov-report=html

The server includes a tool for running TrueNAS middleware tests. Use therun_middleware_tests.shscript:

# Run all middleware tests ./run_middleware_tests.sh # Run a specific test file ./run_middleware_tests.sh . test_construct_schema.py # Clean up test container ./run_middleware_tests.sh /path/to/middleware --cleanup

This is a web browser that enables your coding agent, such as Claude Code, to visit websites on your behalf and assist you in identifying bugs or creating UI test cases.

One shared context layer for AI agents and humans — live API specs, DB schemas, and versioned contracts across repos so every agent and teammate works from the same source of truth.

The MCP server for Bitrix24 provides AI assistants with structured access to the Bitrix24 API. It delivers up-to-date method descriptions, parameters, and valid values, allowing assistants to work with precise data instead of guesswork. This reduces code errors and accelerates Bitrix24 integration development.

A TypeScript MCP server to access Apifox API data via Stdio.

Provides API documentation from Apifox projects as a data source for AI programming tools that support MCP.

A .NET MCP server for interacting with the Autodesk AEC Data Model API and Viewer.

A tool to retrieve API interface information from YApi, with authentication configurable via environment variables.

Clix MCP Server for assisting Clix SDK/API integrations with semantic search across Clix docs and SDK source (iOS, Android, Flutter, React Native).

Check software end-of-life (EOL) dates and support status using the endoflife.date API to provide accurate lifecycle and security information.

Fetches API information from Feishu OpenAPI for seamless integration and management within an IDE.

Headless form infrastructure — forms render natively in your product (no iframe), files upload browser-direct to storage you own, and a coding agent can provision, publish, and query them over MCP.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.