Esp Idf Docs — independently scanned and version-tracked by SaferSkills.
SaferSkills independently audited Esp Idf Docs (Agent Skill) and scored it 100/100 (green). The audit ran 55 deterministic rules across Security, Supply Chain, Maintenance, Transparency, and Community; it found 0 high-severity and 0 lower-severity findings. The full rule-by-rule trace and per-finding evidence are below. Free, methodology-open.
Findings & checks · 0 flagged
Every scanned point with the score it earned and what moved between them.
First recorded scan — no prior version to compare against.
The primary manifest — the file an agent reads to learn what this artifact does.
A Model Context Protocol (MCP) server for exploring ESP-IDF documentation online. This server fetches content directly from the official ESP-IDF documentation website, ensuring you always have access to the latest information. This implementation is inspired by the AWS Documentation MCP Server.
Add the following to your MCP client configuration (e.g., Claude Desktop):
{
"mcpServers": {
"esp-idf-docs": {
"command": "uvx",
"args": ["esp-idf-docs-mcp"],
"env": {
"ESP_IDF_VERSION": "latest",
"ESP_IDF_CHIP_TARGET": "esp32s3"
}
}
}
}# Clone and install for development
git clone https://github.com/raihalea/esp-idf-docs.git
cd esp-idf-docs
# Install dependencies only
uv sync
# Install with development dependencies
uv sync --devSearch ESP-IDF documentation for keywords (case-insensitive).
Parameters:
query (string): Search queryGet the directory structure of ESP-IDF documentation.
Parameters: None
Read the contents of a specific documentation file.
Parameters:
file_path (string): Relative path to the documentation fileFind API references for a specific ESP-IDF component.
Parameters:
component (string): Component or API name to search forESP-IDF documentation version to use (defaults to "latest").
Available versions:
latest - Latest stable versionv5.1 - ESP-IDF v5.1v5.0 - ESP-IDF v5.0v4.4 - ESP-IDF v4.4Setting the environment variable:
# Linux/macOS
export ESP_IDF_VERSION="v5.1"
# Windows Command Prompt
set ESP_IDF_VERSION=v5.1
# Windows PowerShell
$env:ESP_IDF_VERSION="v5.1"Base URL for ESP-IDF documentation (defaults to official site).
export ESP_IDF_BASE_URL="https://docs.espressif.com/projects/esp-idf"Usage examples:
# Run with specific version (PyPI)
ESP_IDF_VERSION="v5.1" uvx esp-idf-docs-mcp
# Run with latest (default)
uvx esp-idf-docs-mcpRun the test suite:
# Install development dependencies
uv sync --dev
# Run all tests
uv run pytest
# Run tests with verbose output
uv run pytest -v
# Run specific test file
uv run pytest tests/test_minimal.py -v
# Run tests with coverage (if coverage is installed)
uv run pytest --cov=src/esp_idf_docs_mcp
# Search document
ESP_IDF_CHIP_TARGET=esp32s3 ESP_IDF_VERSION=latest uv run python test_search.py bluetoothtest_minimal.py): Core functionality and importstest_fixed.py): Actual implementation validationtest_comprehensive.py): Error handling, security, performance, and robustnesstest_explorer_integration.py): End-to-end ESPIDFDocsExplorer testingThis project uses ruff for linting and formatting:
# Install development dependencies
uv sync --dev
# Run linter
uv run ruff check src/ tests/
# Auto-fix linting issues
uv run ruff check src/ tests/ --fix
# Format code
uv run ruff format src/ tests/
# Check formatting
uv run ruff format --check src/ tests/Common development commands:
# Setup development environment
uv sync --dev
# Run all quality checks
uv run ruff check src/ tests/ && uv run ruff format src/ tests/ && uv run pytest && uv run mypy src/ --ignore-missing-imports
# Run individual checks
uv run ruff check src/ tests/ # Linting
uv run ruff check src/ tests/ --fix # Auto-fix linting
uv run ruff format src/ tests/ # Format code
uv run pytest # Run tests
uv run mypy src/ --ignore-missing-imports # Type checking~30 seconds. Free. No account. Every finding cites a rule and a line of evidence.