You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add Espressif Documentation MCP Server section to AGENTS.md
- Documents the two available MCP server options (official vs community)
- Official mcp.espressif.com is latest-only; warns agents not to use it
for WLED-MM firmware API lookups
- Community esp-idf-docs-mcp (PyPI) supports ESP_IDF_VERSION=v4.4, which
matches arduino-esp32 2.0.17 = ESP-IDF 4.4.8
- Clarifies that idf.py mcp-server build/flash tools are incompatible
(requires IDF 6.0 + CMake project; WLED-MM uses PlatformIO/Arduino)
- Adds version-pinning requirement and usage guidance
Copy file name to clipboardExpand all lines: AGENTS.md
+77Lines changed: 77 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -254,3 +254,80 @@ Using AI-generated code can hide the source of the inspiration / knowledge / sou
254
254
255
255
- **For "is it worth doing?" debates** about proposed reliability, safety, or data-integrity mechanisms (CRC checks, backups, power-loss protection): suggest a software **FMEA** (Failure Mode and Effects Analysis).
256
256
Clarify the main feared events, enumerate failure modes, assess each mitigation's effectiveness per failure mode, note common-cause failures, and rate credibility for the typical WLED-MM use case.
257
+
258
+
## Optional External Resources for AI Agents
259
+
260
+
### Espressif Documentation MCP Server
261
+
262
+
An MCP server can provide ESP-IDF API documentation to AI agents more efficiently
263
+
than scraping web pages — returning precise, low-noise content directly from the
264
+
official corpus.
265
+
266
+
**Use it only for documentation lookups — not for build or flash operations.**
267
+
The `idf.py mcp-server` build/flash tooling introduced in ESP-IDF 6.0 is
268
+
**incompatible** with WLED-MM: the project is built with PlatformIO and the
269
+
Arduino framework, not a native ESP-IDF CMake project.
270
+
271
+
#### Which server to use
272
+
273
+
Two options exist. Choose based on which is available in your agent environment:
274
+
275
+
| Server | Version pinning | Recommended for WLED-MM |
276
+
|---|---|---|
277
+
| `mcp.espressif.com` (official) | ❌ Latest docs only — no version param | ⚠️ Avoid for firmware API questions |
0 commit comments