Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Tool Index (A-Z)

Every MCP tool the espctl server exposes, sorted alphabetically. Click the chapter link for the full reference.

ToolCategoryChapter
artifacts.list (alias of list_artifacts)Logs & ArtifactsLogs & Artifacts
artifacts.manifestLogs & ArtifactsLogs & Artifacts
buildBuild LifecycleBuild Lifecycle
build.cancelBuild LifecycleBuild Lifecycle
build.start (alias of build)Build LifecycleBuild Lifecycle
build.statusBuild LifecycleBuild Lifecycle
diag.runPost-build AnalysisPost-build Analysis
doctorESP-IDF StoreESP-IDF Store
doctor.run (alias of doctor)ESP-IDF StoreESP-IDF Store
firmware.downloadFirmware & FlashFirmware & Flash
firmware.listFirmware & FlashFirmware & Flash
flash.runFirmware & FlashFirmware & Flash
generate_build_planBuild LifecycleBuild Lifecycle
get_clean_planBuild LifecycleBuild Lifecycle
idf.select_version (alias of idf_select_version)Project ManagementProject Management
idf.versionsESP-IDF StoreESP-IDF Store
idf_select_versionProject ManagementProject Management
list_artifactsLogs & ArtifactsLogs & Artifacts
logs.tailLogs & ArtifactsLogs & Artifacts
monitor.runFirmware & FlashFirmware & Flash
parse_build_errorsLogs & ArtifactsLogs & Artifacts
parse_size_reportLogs & ArtifactsLogs & Artifacts
project.initProject ManagementProject Management
project.createProject ManagementProject Management
project.create_componentProject ManagementProject Management
rshome.assembly.previewRSHome Device ToolsRSHome
rshome.codegen.previewRSHome Device ToolsRSHome
rshome.components.addRSHome Device ToolsRSHome
rshome.components.listRSHome Device ToolsRSHome
rshome.modules.listRSHome Device ToolsRSHome
rshome.pin_mapRSHome Device ToolsRSHome
rshome.solution.parametersRSHome Device ToolsRSHome
rshome.solutions.listRSHome Device ToolsRSHome
rshome.validateRSHome Device ToolsRSHome
sbom.createPost-build AnalysisPost-build Analysis
set_targetProject ManagementProject Management
set_target.runBuild LifecycleBuild Lifecycle
size.runPost-build AnalysisPost-build Analysis
store_versionsESP-IDF StoreESP-IDF Store
validate_configProject ManagementProject Management

Resource URIs

Not technically tools, but reachable through the same MCP resources/read verb. Listed alphabetically.

URIChapter
build://artifacts/{target}Resources
build://log/latestResources
build://log/{task_id}Resources
install://claude-codeResources
install://claude-desktopResources
install://codexResources
install://cursorResources
install://opencodeResources
install://overviewResources
project://compile_commandsResources
project://configResources
project://idf-versionResources
project://sdkconfigResources
store://manifestResources
store://versionsResources

CLI Subcommands (A-Z)

Every espctl subcommand exposed by crates/espctl/src/main.rs. The chapter link goes to the section that documents the subcommand’s flags, exit codes, and examples.

SubcommandCategoryChapter
espctl artifactsLogs & ArtifactsLogs & Artifacts
espctl buildBuild LifecycleBuild Lifecycle
espctl cleanLogs & ArtifactsLogs & Artifacts
espctl doctorESP-IDF StoreESP-IDF Store
espctl flashFirmware & FlashFirmware & Flash
espctl ide syncIDE IntegrationIDE Integration
espctl loginGetting StartedPlan-only vs Remote Build
espctl mcp serveTools OverviewQuick Start
espctl monitorFirmware & FlashFirmware & Flash
espctl portsFirmware & FlashFirmware & Flash
espctl probeFirmware & FlashFirmware & Flash
espctl set-targetProject ManagementProject Management
espctl sizePost-build AnalysisPost-build Analysis
espctl skillsCLI UtilitiesCLI Utilities
espctl versionCLI UtilitiesCLI Utilities

Global flags

FlagChapter
--jsonCLI Utilities
--quietCLI Utilities
--skills (early exit)CLI Utilities

Built-in prompts

PromptChapter
configure-projectBuilt-in Prompts
convert-to-componentBuilt-in Prompts
diagnose-build-errorBuilt-in Prompts
diagnose-cmake-errorBuilt-in Prompts
migrate-idf-versionBuilt-in Prompts
optimize-flash-sizeBuilt-in Prompts
setup-ble-matterBuilt-in Prompts
setup-mcp-clientBuilt-in Prompts

See also