You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,12 +46,19 @@
46
46
47
47
## Installation
48
48
49
-
### Quick MCP client setup
49
+
### Using `.mcpb` package
50
50
51
-
- Configure supported clients automatically with `uvx --from crowdsec-local-mcp init <client>`, where `<client>` is one of `claude-desktop`, `chatgpt`, `vscode`, or `stdio`:
51
+
If you're using `claude desktop`, you can configure the MCP directly by double-clicking the `.mcpb` file that accompanies the release.
52
+
53
+
> [!IMPORTANT]
54
+
> On MacOS, configure `uv` path in the extension settings if `uv` isn't installed in the standard path.
55
+
56
+
### Using `uvx`
57
+
58
+
- Configure supported clients automatically with `uvx --from crowdsec-local-mcp init <client>`, where `<client>` is one of `claude-desktop`, `claude-code`, `chatgpt`, `vscode`, or `stdio`:
Run `uvx --from crowdsec-local-mcp init --help` to see all flags and supported targets.
@@ -60,7 +67,8 @@ Run `uvx --from crowdsec-local-mcp init --help` to see all flags and supported t
60
67
61
68
The `init` helper writes the CrowdSec MCP server definition into the client’s JSON configuration:
62
69
63
-
-`claude-desktop` → `claude_desktop_config.json`
70
+
-`claude-desktop` → `claude_desktop_config.json` in the Claude Desktop settings directory
71
+
-`claude-code` → invoke `claude mcp` command with needed args
64
72
-`chatgpt` → `config.json` in the ChatGPT Desktop settings directory
65
73
-`vscode` → `mcp.json` for VS Code (stable and insiders are both detected)
66
74
@@ -72,6 +80,10 @@ By default the CLI launches the server with `uvx --from crowdsec-local-mcp crowd
72
80
73
81
`stdio` does not modify any files. Instead, `init stdio` prints a ready-to-paste JSON snippet that you can drop into any stdio-compatible MCP client configuration. This is useful when you want to manually wire the server into tools that do not have built-in automation support yet.
74
82
83
+
## Troubleshooting
84
+
85
+
If you just installed the mcp extension via `.mcpb` and `uv` or `uvx` isn't in the standard path, check the extension settings to configure `uv` path.
86
+
75
87
## Logging
76
88
77
89
- The MCP server writes its log file to your operating system's temporary directory. On Linux/macOS this is typically `/tmp/crowdsec-mcp.log`; on Windows it resolves via `%TEMP%\crowdsec-mcp.log`.
0 commit comments