diff --git a/docs-site/src/assets/hero-chip.svg b/docs-site/src/assets/hero-chip.svg new file mode 100644 index 0000000..ea0cfd1 --- /dev/null +++ b/docs-site/src/assets/hero-chip.svg @@ -0,0 +1,119 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ESP32 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs-site/src/content/docs/index.mdx b/docs-site/src/content/docs/index.mdx index 5cfaba4..bfd1d2a 100644 --- a/docs-site/src/content/docs/index.mdx +++ b/docs-site/src/content/docs/index.mdx @@ -3,23 +3,25 @@ title: mcesptool description: ESP32 and ESP8266 development through Model Context Protocol template: splash hero: - tagline: ESP32 and ESP8266 development through Model Context Protocol + tagline: Flash firmware, manage partitions, burn eFuses, run diagnostics, and deploy OTA updates on ESP32 and ESP8266 — all through natural language. + image: + file: ../../assets/hero-chip.svg actions: - text: Get Started link: /tutorials/getting-started/ icon: right-arrow - - text: Tool Reference + - text: Capabilities link: /reference/ variant: minimal --- -import { CardGrid, Card } from "@astrojs/starlight/components"; +import { Card, CardGrid, Tabs, TabItem } from '@astrojs/starlight/components'; - - Complete ESP development toolkit from chip detection to production - programming. Flash firmware, manage partitions, read eFuses, run - diagnostics, and deploy OTA updates -- all through natural language. + + From chip detection to production programming — just describe what + you need. Flash firmware, manage partitions, read eFuses, run + diagnostics, and deploy OTA updates through conversation. Full QEMU emulation lets you flash, debug, and test without physical @@ -37,3 +39,107 @@ import { CardGrid, Card } from "@astrojs/starlight/components"; require explicit intent. + +## Example Conversation + +
+ +``` +You: I just plugged in an ESP32 board. Can you detect it and flash + the latest firmware? + +Assistant: I'll scan for connected ESP devices first. + + [Using esp_scan_ports] + + Found 1 device: + /dev/ttyUSB0 — USB-SERIAL CH340 (1a86:7523) + + Let me identify the chip. + + [Using esp_detect_chip with port="/dev/ttyUSB0"] + + Detected: + Chip: ESP32-D0WD-V3 (rev 3.01) + Flash: 4 MB + MAC: a0:b7:65:cc:58:c4 + Crystal: 40 MHz + + Now I'll flash your firmware binary. + + [Using esp_flash_firmware with port="/dev/ttyUSB0", + firmware_path="build/app.bin", address="0x10000"] + + Flashing... ████████████████████ 100% + Hash verified: a3c7f8... + + Verifying the flash contents match. + + [Using esp_verify_flash with port="/dev/ttyUSB0", + firmware_path="build/app.bin", address="0x10000"] + + ✓ Flash verified — firmware matches source binary exactly. + Device is ready. +``` + +
+ +## Quick Install + + + +```bash +# Run directly — no install needed +uvx mcesptool + +# Or install as a persistent tool +uv tool install mcesptool +``` + + +```bash +git clone https://git.supported.systems/warehack.ing/mcp-esptool +cd mcp-esptool +uv sync +uv run mcesptool +``` + + + +### Add to your MCP client + +```bash +# Claude Code +claude mcp add mcesptool -- uvx mcesptool + +# Or add to any MCP-compatible client's config: +# command: uvx +# args: ["mcesptool"] +``` + +## Supported Chips + +| Chip | Architecture | QEMU Support | +|------|-------------|--------------| +| ESP32 | Xtensa LX6 | Yes | +| ESP32-S2 | Xtensa LX7 | — | +| ESP32-S3 | Xtensa LX7 | Yes | +| ESP32-C3 | RISC-V | Yes | +| ESP32-C6 | RISC-V | — | +| ESP8266 | Xtensa L106 | — | + +## Capabilities + +| Category | Count | What you can ask for | +|----------|------:|-------------| +| Chip Control | 7 | Detect devices, scan ports, reset chips, load firmware to RAM | +| Flash Operations | 6 | Flash, read back, erase, backup, multi-flash, verify | +| Partitions | 3 | Create OTA layouts, custom partition tables, analyze existing | +| Security | 4 | Run security audits, enable flash encryption, read and burn eFuses | +| Firmware Builder | 3 | Convert ELF to flashable binaries, analyze firmware images | +| OTA Management | 3 | Create update packages, deploy over-the-air, rollback | +| Production | 3 | Factory program devices, batch operations, run QC checks | +| Diagnostics | 3 | Dump memory, profile performance, generate reports | +| QEMU Emulation | 5 | Spin up virtual ESPs, flash them, check status | +| Server | 3 | Check server health, list available capabilities | +| **Total** | **47** | | diff --git a/docs-site/src/styles/global.css b/docs-site/src/styles/global.css index e31ded6..0d643c9 100644 --- a/docs-site/src/styles/global.css +++ b/docs-site/src/styles/global.css @@ -16,6 +16,17 @@ --sl-color-black: #0f172a; } +/* Conversation example block on splash page */ +.conversation-block .expressive-code { + border: 1px solid color-mix(in srgb, var(--sl-color-accent) 30%, transparent); + border-radius: 0.75rem; + overflow: hidden; +} + +.conversation-block .expressive-code pre { + background: color-mix(in srgb, var(--sl-color-accent-low) 50%, var(--sl-color-black)) !important; +} + :root[data-theme="light"] { --sl-color-accent-low: #ccfbf1; --sl-color-accent: #0d9488;