Skip to content

Commit 798436c

Browse files
authored
Update README.md
1 parent e5c87df commit 798436c

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# KiCad MCP Server
22

3-
> ⚠️ **WARNING**: This project was quickly hacked together and is largely untested. Expect things to break. Use at your own risk. I plan on improving it over time, but if you find bugs, please open an issue or submit a pull request to fix them (see Contributing section below).
4-
5-
> ⚠️ **WARNING**: This project is optimized for Mac. While there exists some basic support for Windows and Linux, not all functionality is guaranteed to work.
6-
73
This guide will help you set up a Model Context Protocol (MCP) server for KiCad. While the examples in this guide often reference Claude Desktop, the server is compatible with **any MCP-compliant client**. You can use it with Claude Desktop, your own custom MCP clients, or any other application that implements the Model Context Protocol.
84

95
## Table of Contents
@@ -23,11 +19,10 @@ This guide will help you set up a Model Context Protocol (MCP) server for KiCad.
2319

2420
## Prerequisites
2521

26-
- macOS, Windows, or Linux with KiCad installed
22+
- macOS, Windows, or Linux
2723
- Python 3.10 or higher
2824
- KiCad 9.0 or higher
2925
- Claude Desktop (or another MCP client)
30-
- Basic familiarity with the terminal
3126

3227
## Installation Steps
3328

@@ -71,7 +66,6 @@ KICAD_SEARCH_PATHS=~/pcb,~/Electronics,~/Projects/KiCad
7166
Once the environment is set up, you can run the server:
7267

7368
```bash
74-
# Or run directly
7569
python main.py
7670
```
7771

@@ -136,6 +130,8 @@ The Model Context Protocol (MCP) defines three primary ways to provide capabilit
136130
- Invoked by user choice (typically from a menu)
137131
- Example: The `debug_pcb_issues` prompt helps users troubleshoot PCB problems
138132

133+
For more information on resources vs tools vs prompts, read the [MCP docs](https://modelcontextprotocol.io/docs/concepts/architecture).
134+
139135
## Feature Highlights
140136

141137
The KiCad MCP Server provides several key features, each with detailed documentation:
@@ -161,7 +157,7 @@ The KiCad MCP Server provides several key features, each with detailed documenta
161157
- **Circuit Pattern Recognition**: Automatically identify common circuit patterns in your schematics
162158
- *Example:* "What power supply topologies am I using in my IoT device?" → Identifies buck, boost, or linear regulators
163159

164-
For more examples and details on each feature, see the dedicated guides in the documentation.
160+
For more examples and details on each feature, see the dedicated guides in the documentation. You can also ask the LLM what tools it has access to!
165161

166162
## Natural Language Interaction
167163

@@ -272,6 +268,8 @@ If you encounter issues:
272268

273269
See [Troubleshooting Guide](docs/troubleshooting.md) for more details.
274270

271+
If you're still not able to troubleshoot, please open a Github issue.
272+
275273
## Contributing
276274

277275
Want to contribute to the KiCad MCP Server? Here's how you can help improve this project:

0 commit comments

Comments
 (0)