MCP/mcp-arduino
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
Volt23 2025-04-15 18:12:36 +02:00
parent 7d61d2e856
commit 93e1017b8f
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -157,19 +157,24 @@ The server will start and listen for connections from an MCP client via standard
When configuring an MCP client (such as Claude Desktop) to launch this server, you must ensure the `command` in your JSON config points to the correct executable. **If you are using pyenv or a custom Python environment, specify the full path to the `mcp-arduino-server` binary where it was installed.** When configuring an MCP client (such as Claude Desktop) to launch this server, you must ensure the `command` in your JSON config points to the correct executable. **If you are using pyenv or a custom Python environment, specify the full path to the `mcp-arduino-server` binary where it was installed.**
For example: For example, to ensure WireViz is always found regardless of PATH issues, you can set the `WIREVIZ_PATH` environment variable in your MCP client config if supported:
```json ```json
{ {
"mcpServers": { "mcpServers": {
"arduino": { "arduino": {
"command": "/Users/<your-username>/.pyenv/versions/<your-python-version>/bin/mcp-arduino-server", "command": "/Users/<your-username>/.pyenv/versions/<your-python-version>/bin/mcp-arduino-server",
"args": [] "args": [],
"env": {
"WIREVIZ_PATH": "/Users/<your-username>/.pyenv/versions/<your-python-version>/bin/wireviz"
}
} }
} }
} }
``` ```
Replace `<your-username>` and `<your-python-version>` with your actual username and Python version. This ensures the MCP client launches the correct environment and always finds WireViz, even if your PATH is not set up for GUI apps.
Replace `<your-username>` and `<your-python-version>` with your actual username and Python version as appropriate. This ensures the MCP client launches the correct environment and finds all dependencies. Replace `<your-username>` and `<your-python-version>` with your actual username and Python version as appropriate. This ensures the MCP client launches the correct environment and finds all dependencies.
## Available Tools (MCP Interface) ## Available Tools (MCP Interface)

2
pyproject.toml
View File

@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "mcp-arduino-server" name = "mcp-arduino-server"
version = "0.1.0" # Start with an initial version version = "0.1.1" # Start with an initial version
authors = [ authors = [
{ name="Your Name", email="your.email@example.com" }, { name="Your Name", email="your.email@example.com" },
] ]