Skip to main content
Glama
oaslananka

kicad-mcp-pro

by oaslananka

KiCad 可编程覆盖率

KiCad MCP Pro 是一个用于 KiCad EDA 工作流程的模型上下文协议服务器。它公开了用于原理图、PCB、验证、DFM 和制造导出自动化的工具、资源和提示(prompts)。

服务器现在以受限的 default 配置文件启动:24 个只读审查工具,而不是完整的 377 个工具专家目录。使用 build 带写入模式进行受控编辑,release 带制造模式进行人工把控的交接,或仅对高级可信客户端使用 expert/full。请参阅 docs/agents/progressive-disclosure.md。

遥测和错误报告默认禁用。选择加入的 OpenTelemetry 配置记录在 docs/configuration.md 中,隐私规则记录在 docs/privacy.md 中。

范围与诚实声明

KiCad MCP Pro 是一个专业的首轮设计和审查助手,而不是自动签署授权机构。ERC/DRC 和导出管道驱动 KiCad 自己的引擎。信号完整性、电源完整性、EMC 和热管理工具是一阶闭合形式估计(通常精度约 5–10%)——快速的首轮审查,而不是替代 2D/3D 场求解器、EM/FEA 仿真或正式签署。实时元器件 sourcing 默认使用 JLCPCB 公开目录;Nexar、DigiKey 和 Mouser 仅在其 API 凭证配置后可用。服务器驱动了 KiCad 可编程表面的多少部分,会在能力覆盖率矩阵中公开跟踪。

Related MCP server: KiCad MCP Server

项目身份

字段

值

规范仓库

oaslananka/kicad-mcp-pro

PyPI 包

kicad-mcp-pro

npm 封装

kicad-mcp-pro

MCP 注册名称

io.github.oaslananka/kicad-mcp-pro

版本

3.32.0

OSS 成熟度报告

docs/repo-maturity-report.md

OpenSSF 证据

docs/openssf-evidence.md

快速开始

桌面应用

从 GitHub 发布页面 下载最新安装程序。Tauri 桌面应用会自动启动 Python 仪表板服务器,并在 http://127.0.0.1:3334/ui 打开 GUI。桌面发布版本会启动匹配的精确后端版本,并在使用前验证其桌面兼容性握手;请参阅 安装。

CLI

uvx kicad-mcp-pro init
uvx kicad-mcp-pro tray
uvx kicad-mcp-pro dashboard --open
uvx kicad-mcp-pro --transport streamable-http --port 3334

Web 仪表板

uvx kicad-mcp-pro dashboard --host 127.0.0.1 --port 3334 --open
# http://127.0.0.1:3334/ui

文档

文档按从设置到操作的组织方式排列:

  1. 安装

  2. 客户端配置

  3. 运行时配置

  4. 工具参考

  5. 工作流程

  6. 发布流程

  7. 安全与隐私

  8. KiCad 能力覆盖率 — 此服务器驱动了 KiCad 可编程表面的多少部分

  9. 错误代码目录 — 稳定的错误代码、重试类别和恢复

  10. 工单审计 — 加固工单的当前状态

kicad_capability_parity() 工具按工作流领域报告此服务器可以驱动 KiCad 可编程到达表面的多少部分(当前为 76.3%),将真正的 gap 与 KiCad 未暴露无头 API 的 gui-only-no-api 项目区分开来。

已发布的文档站点位于 https://oaslananka.github.io/kicad-mcp-pro/。

传输方式

KiCad MCP Pro 支持 stdio 和 Streamable HTTP。Streamable HTTP 默认在 /mcp 上提供服务,并可通过 KICAD_MCP_MOUNT_PATH 移动。

uvx kicad-mcp-pro --transport streamable-http --host 127.0.0.1 --port 3334

Streamable HTTP 客户端必须发送:

  • Accept: application/json, text/event-stream

  • Content-Type: application/json

  • MCP-Protocol-Version: 2025-11-25(初始化后)

  • MCP-Session-Id(当 KICAD_MCP_STATEFUL_HTTP=1 时,在后续请求中)

默认情况下,Streamable HTTP 是无状态的,因此 ChatGPT 风格的连接器无需会话标头注入代理即可初始化和调用 tools/list。设置 KICAD_MCP_STATEFUL_HTTP=1 以要求在 initialize 之后使用会话 ID。

已弃用的 HTTP+SSE 备用路由默认禁用。仅对无法使用 Streamable HTTP 的旧客户端设置 KICAD_MCP_LEGACY_SSE=1。

安装

已发布的包:

uvx kicad-mcp-pro --help
npx kicad-mcp-pro --help

在受支持的 Linux 主机上进行全新源码检出:

./scripts/bootstrap-dev.sh
source .dev-env.sh
pnpm run dev:doctor -- --ci

仓库引导程序会安装校验和固定的 Python、uv/uvx、Node.js、pnpm、Task 和 Rust 工具链到忽略的检出本地根目录中,并执行冻结依赖安装。它不会修改全局工具目录。请参阅可重现引导指南了解 --core-only、--check、清理、升级和 KiCad 能力模式。

包元数据

规范的元数据输入是 pyproject.toml(用于包版本和仓库身份)和 compatibility.yaml(用于 KiCad 和 MCP 支持策略)。server.json 是生成的注册清单。pnpm run metadata:sync 渲染公共表面,pnpm run metadata:check 在 CI 和发布验证中验证它们。

使用方法

使用 kicad-mcp-pro --help 查看 CLI 命令,并参考 docs/client-configuration.md 配置 MCP 客户端。生成的工具目录可在 docs/tools-reference.generated.md 中找到。

代理插件和技能

此仓库拥有 KiCad MCP Pro 的产品级代理插件和 KiCad 特定技能。中央 agent-tools 仓库应列出此插件,但清单和工作流指令在此处,以便与实际 MCP 服务器工具保持同步。

文件

用途

.claude-plugin/plugin.json

面向兼容代理运行时和商城目录的产品级插件清单。

.mcp.json

Claude Code 项目本地 MCP 服务器配置。

.codex/config.example.toml

Codex CLI MCP 配置示例。

.vscode/mcp.example.json

VS Code / GitHub Copilot 工作区 MCP 配置示例。

opencode.example.jsonc

OpenCode 项目 MCP 配置示例。

.opencode/skills/

OpenCode 原生镜像技能定义。

docs/agent-runtime-config.md

代理运行时设置与验证矩阵。

skills/kicad-design-review/SKILL.md

全面的 KiCad 设计审查技能。

skills/pcb-design/SKILL.md

PCB 设计、布局检查、放置、布线、叠层和板级质量工作流。

skills/drc-check/SKILL.md

ERC/DRC 执行、分类、豁免审查和重新验证工作流。

skills/fabrication-output/SKILL.md

制造导出、DFM、发布证据和制造包工作流。

skills/schematic-review/SKILL.md

原理图检查、ERC、连接性、电源、符号和可读性工作流。

代理设置

KiCad MCP Pro 可以通过已发布的 Python 包、npm 包装器或 server.json 中声明的容器元数据启动。常见的本地启动方式有:

uvx kicad-mcp-pro --transport stdio
uvx kicad-mcp-pro --transport streamable-http --host 127.0.0.1 --port 3334
npx kicad-mcp-pro --help

对于源码检出,在发布插件更改之前,请运行正常的仓库验证路径:

corepack pnpm run metadata:check
python3 -m json.tool .claude-plugin/plugin.json >/dev/null

验证工作流

在将此插件列为 agent-tools 中的活动插件之前,请验证至少一个兼容的 代理运行时能够:

  1. 发现 .claude-plugin/plugin.json。

  2. 通过 stdio 或 Streamable HTTP 启动或连接到 kicad-mcp-pro。

  3. 调用 kicad_get_server_info 或 kicad_get_project_info。

  4. 从 skills/ 加载一个技能,并遵循工作流而不引用缺失的工具。

  5. 分别报告 ERC、DRC、DFM、导出工件、假设和人工审查要求。

KiCad MCP Pro 是一个工程助手,而不是自主制造签核权限。生成的 PCB 和制造输出 在制造或组装之前需要合格的人工审查。

开发

新贡献者应从 ARCHITECTURE.md 开始,该文件映射了 五个层(传输 → MCP 协议 → 编排 → KiCad 适配器接缝 → 纯领域),并精确展示了如何添加新工具。运行时模型和 质量门控栈记录在 docs/development/architecture.md 中。

该项目使用 Taskfile.yml 进行常见开发命令。克隆仓库后:

task install     # Install all dependencies (pnpm + uv)
task verify      # Run the local quality gate: lint → format → typecheck → test → build
task test        # Run unit tests only
task lint        # Run lint and metadata checks
task format      # Auto-format the codebase
task typecheck   # Run strict static type checking
task build       # Build release artifacts
task ci          # Run the local equivalent of the full CI pipeline
task hooks       # Install local git hooks

所有更改在提交拉取请求之前必须通过 task verify。

贡献

在提交拉取请求之前,请阅读 CONTRIBUTING.md。所有 更改必须通过仓库的格式、lint、类型检查、测试、工作流、安全 和包元数据门控。

引用本软件

如果您在研究或技术出版物中使用 KiCad MCP Pro,请通过其 DOI 引用 存档版本(完整元数据请参见 CITATION.cff):

@software{aslan_kicad_mcp_pro,
  author  = {Aslan, Osman},
  title   = {KiCad MCP Pro},
  license = {MIT},
  url     = {https://github.com/oaslananka/kicad-mcp-pro},
  doi     = {10.5281/zenodo.21283791}
}

每个 GitHub 版本都存档在 Zenodo 上,使用此概念 DOI,该 DOI 始终解析为最新版本。

许可证

KiCad MCP Pro 根据 MIT 许可证 提供。

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    A
    maintenance
    MCP servers for KiCad schematic, PCB, symbol, footprint, and project automation, enabling AI-assisted electronic design via tools for read/write, analysis, and exports.
    109
    409 PyPI
    11
    MIT
  • A
    license
    B
    quality
    A
    maintenance
    An MCP server that enables AI assistants to analyze schematics, inspect PCBs, trace connections, validate designs, and generate embedded code for KiCad projects.
    39
    139
    MIT
  • A
    license
    B
    quality
    B
    maintenance
    An MCP server providing full control over KiCad 10, enabling PCB editing, schematic editing, design data, and production output via natural language.
    102
    1
    MIT
  • A
    license
    Not graded
    quality
    C
    maintenance
    An MCP server that gives AI agents end-to-end control of KiCad 9+ for rule checks, manufacturing exports, production-readiness certification, and live PCB editor control.
    MIT