stm32-mcp-docs
Allows the MCP server to be accessed from multiple machines via Tailscale network mode.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@stm32-mcp-docsHow to configure SPI on STM32F4?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
STM32 MCP Documentation Server
An MCP (Model Context Protocol) server that provides semantic search over STM32 microcontroller documentation for use with Claude Code and other AI assistants. Features intelligent document chunking, ChromaDB vector storage, and 16 specialized agents for different embedded development domains.
Features
One-Command Install: Install as a Claude Code plugin with one command
Auto-Setup: MCP server, agents, and commands auto-configured on install
Semantic Search: Find relevant documentation using natural language queries
Peripheral-Specific Search: Filter results by STM32 peripheral (GPIO, UART, SPI, etc.)
Code Examples: Retrieve working code examples for any topic
HAL Function Lookup: Get documentation for specific STM32 HAL/LL library functions
16 Specialized Agents: Domain-specific agents for firmware, debugging, power, security, and more
4 Slash Commands: Quick access via
/stm32,/stm32-hal,/stm32-init,/stm32-debugNo Hardcoded Paths: Fully portable installation
Related MCP server: Sourcerer MCP
Quick Start
Plugin Installation (Recommended)
# Install the STM32 plugin
/plugin install github:creativec09/stm32This single command installs:
MCP Server: Auto-configured via
mcp-config.json16 Agents: Available immediately for specialized STM32 assistance
4 Slash Commands:
/stm32,/stm32-hal,/stm32-init,/stm32-debug
Alternative: Manual MCP Installation
If you prefer not to use the plugin system, you can install just the MCP server.
Ubuntu 24 / WSL / Linux (auto-installs uv if needed):
claude mcp add-json stm32-docs --scope user '{"command":"bash","args":["-c","export PATH=\"$HOME/.local/bin:$PATH\" && (command -v uvx >/dev/null 2>&1 || curl -LsSf https://astral.sh/uv/install.sh | sh -s -- -q) && uvx --from git+https://github.com/creativec09/stm32.git stm32-mcp-docs"]}'If you already have uv installed:
claude mcp add stm32-docs --scope user -- uvx --from git+https://github.com/creativec09/stm32.git stm32-mcp-docsNote: For private repositories, include a GitHub Personal Access Token with repo scope in the URL: git+https://TOKEN@github.com/...
Start Using
After installation, restart Claude Code and use slash commands:
/stm32 How do I configure UART with DMA?
/stm32-init SPI master mode at 10MHz
/stm32-hal HAL_GPIO_Init parameters
/stm32-debug UART not receiving dataOr ask naturally:
"Show me how to configure GPIO interrupts on STM32H7"
"Why is my I2C peripheral returning HAL_TIMEOUT?"Table of Contents
Installation
Prerequisites
Python 3.11 or higher (pre-installed on Ubuntu 24)
curl (pre-installed on Ubuntu 24)
Claude Code CLI
Note: uv is automatically installed on first use if not present.
Method 1: Plugin Installation (Recommended)
/plugin install github:creativec09/stm32This installs everything automatically:
MCP server configuration
16 specialized agents
4 slash commands
Method 2: Manual MCP + pip Installation
# Install the package
pip install git+https://github.com/creativec09/stm32.git
# Register with Claude Code
claude mcp add stm32-docs --scope user -- python -m mcp_serverMethod 3: Development Installation
# Clone the repository
git clone https://github.com/creativec09/stm32.git
cd stm32-agents
# Create virtual environment
python -m venv .venv
source .venv/bin/activate # Linux/macOS
# .venv\Scripts\activate # Windows
# Install in development mode
pip install -e ".[dev]"
# Register with Claude Code
claude mcp add stm32-docs --scope user -- python -m mcp_serverMCP Tools
The server provides 15+ tools for STM32 documentation:
Tool | Description |
| Semantic search across all documentation |
| Get documentation for a specific peripheral |
| Find code examples for a topic |
| Get detailed register documentation |
| Look up HAL/LL function documentation |
| Find solutions to errors and issues |
| Get peripheral initialization code |
| Clock tree configuration examples |
| Compare peripheral features |
| Migration guides between STM32 families |
| Interrupt handling examples |
| DMA configuration examples |
| Low power mode configuration |
| HAL callback examples |
| Complete initialization templates |
| List available peripherals |
MCP Resources
Resource URI | Description |
| Server status and statistics |
| Health check |
| List documented peripherals |
| Database statistics |
Specialized Agents
16 domain-specific agents are included in the plugin:
Agent | Domain | Key Topics |
| Triage | Query classification, routing |
| Triage | Initial query analysis |
| Core Development | General firmware questions |
| Core Development | HAL/LL, timers, DMA, interrupts, NVIC, RCC |
| Debugging | HardFault analysis, SWD, trace |
| Updates | Bootloader development |
| Updates | IAP, DFU, system bootloader |
| Communication | UART, SPI, I2C, CAN, USB, Ethernet |
| Analog | ADC, DAC, OPAMP, comparators, sensors |
| Display | LTDC, DMA2D, DCMI, TouchGFX |
| Power | General power optimization |
| Power | Sleep, Stop, Standby, battery |
| Certification | Safety-critical development |
| Certification | IEC 61508, ISO 26262, Class B |
| Security | Secure boot, TrustZone, crypto, RNG |
| PCB/Hardware | EMC, thermal, oscillators, layout |
See docs/AGENT_QUICK_REFERENCE.md for detailed agent capabilities.
Usage
Slash Commands
/stm32 <query> - General STM32 documentation search
/stm32-init <peripheral> - Get initialization code for a peripheral
/stm32-hal <function> - Look up HAL function documentation
/stm32-debug <issue> - Troubleshoot an STM32 issueNatural Language Queries
Agents automatically search documentation:
"Show me how to configure GPIO interrupts on STM32H7"
"Why is my I2C peripheral returning HAL_TIMEOUT?"
"How to enter Stop mode and wake up on UART?"Network Mode (Tailscale)
For accessing from multiple machines:
# Start server in network mode
STM32_SERVER_MODE=network python -m mcp_server --port 8765
# On client machines
claude mcp add stm32-docs --scope user --type sse --url "http://YOUR_TAILSCALE_IP:8765/sse"Configuration
Configuration via environment variables:
STM32_SERVER_MODE=local # local, network
STM32_HOST=0.0.0.0 # Host to bind (network mode)
STM32_PORT=8765 # Port (network mode)
STM32_COLLECTION_NAME=stm32_docs # ChromaDB collection name
STM32_EMBEDDING_MODEL=all-MiniLM-L6-v2
STM32_LOG_LEVEL=INFOProject Structure
stm32-agents/
├── .claude-plugin/ # Plugin manifest
│ └── plugin.json # Plugin configuration
├── agents/ # Agent definitions (16 agents)
├── commands/ # Slash command definitions
├── mcp-config.json # MCP server configuration
├── mcp_server/ # MCP server implementation
│ ├── server.py # Main server with tools/resources
│ ├── __main__.py # Module entry point
│ ├── config.py # Configuration management
│ ├── markdowns/ # Bundled STM32 documentation (80 files)
│ └── agents/ # Bundled agent definitions
├── pipeline/ # Document processing pipeline
├── storage/ # Vector storage layer
├── scripts/ # CLI utilities
├── tests/ # Test suite
└── docs/ # Comprehensive documentationDevelopment
Setup Development Environment
git clone https://github.com/creativec09/stm32.git
cd stm32-agents
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"Running Tests
pytest tests/
pytest tests/ --cov=mcp_server --cov=pipeline --cov=storageCode Quality
black .
isort .
ruff check .
mypy mcp_server pipeline storageSystem Requirements
Requirement | Minimum | Recommended |
Python | 3.11 | 3.12 |
RAM | 4GB | 8GB |
Disk Space | 1GB | 2GB |
OS | Linux, macOS, Windows (WSL2) | Linux |
Performance Characteristics
Metric | Value |
First Run | 5-10 minutes (builds database) |
Subsequent Starts | <5 seconds |
Query Response | <100ms (warm) |
Database Size | ~500MB |
Total Chunks | 13,815 |
Documentation Files | 80 |
Troubleshooting
"No documentation found"
Database may not have built yet. Wait for auto-ingestion on first run, or:
python scripts/ingest_docs.py --clearSlow first request
First request takes 5-10 minutes due to:
Loading embedding model
Building vector database from 80 documents
Subsequent requests are fast (<100ms).
Server won't start
# Verify registration
claude mcp list
# Check server status
claude mcp status stm32-docs
# If uv issues, reinstall manually:
curl -LsSf https://astral.sh/uv/install.sh | shFor more troubleshooting help, see docs/GETTING_STARTED.md.
Uninstall
Using Plugin System (Recommended)
If you installed via plugin:
# Remove the plugin (removes agents, commands, MCP config)
/plugin uninstall stm32-agents
# Clean up database (optional)
stm32-uninstallManual Uninstall
If you installed manually:
# Step 1: Remove MCP server configuration
claude mcp remove stm32-docs --scope user
# Step 2: Clean up database
stm32-uninstallUninstall Options
stm32-uninstall --dry-run # Preview what will be removed
stm32-uninstall --yes # Skip confirmation promptLicense
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
Built with:
MCP (Model Context Protocol) - AI integration framework by Anthropic
ChromaDB - Vector database
Sentence Transformers - Embedding models
FastMCP - MCP server framework
Support
This server cannot be installed
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Latest Blog Posts
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/creativec09/stm32'
If you have feedback or need assistance with the MCP directory API, please join our Discord server