@aarav-j/zephyr-mcp-server 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,6 +4,23 @@ An MCP (Model Context Protocol) server that gives LLMs grounded access to Zephyr
4
4
 
5
5
  ## Quick Start
6
6
 
7
+ ### Option 1: npx (no install)
8
+
9
+ ```json
10
+ {
11
+ "mcpServers": {
12
+ "zephyr": {
13
+ "command": "npx",
14
+ "args": ["-y", "@aarav-j/zephyr-mcp-server"]
15
+ }
16
+ }
17
+ }
18
+ ```
19
+
20
+ First startup auto-downloads the server + pre-built index (8.5 MB). Zero setup.
21
+
22
+ ### Option 2: Clone from GitHub
23
+
7
24
  ```bash
8
25
  git clone https://github.com/Aarav-J/zephyr-mcp-server.git
9
26
  cd zephyr-mcp-server
@@ -18,14 +35,12 @@ Add to your MCP client config (e.g. `~/.cursor/mcp.json`):
18
35
  "mcpServers": {
19
36
  "zephyr": {
20
37
  "command": "node",
21
- "args": ["/absolute/path/to/zephyr-mcp-server/dist/index.js"]
38
+ "args": ["/path/to/zephyr-mcp-server/dist/index.js"]
22
39
  }
23
40
  }
24
41
  }
25
42
  ```
26
43
 
27
- First startup auto-downloads a pre-built index (8.5 MB) with data from the latest Zephyr release. No manual setup needed.
28
-
29
44
  ## Tools
30
45
 
31
46
  ### `get_function_signature`
@@ -193,7 +208,3 @@ PRs welcome. Key areas for improvement:
193
208
  ## License
194
209
 
195
210
  MIT
196
-
197
- ---
198
-
199
- Built for [Oh My Pi](https://github.com/Aarav-J/personal_hermes) club.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aarav-j/zephyr-mcp-server",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "MCP server for Zephyr RTOS documentation - API signatures, Kconfig symbols, and Devicetree bindings",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",