on main help sign in
docs(readme) add stdio MCP; add logs section
4503e69Manuel Odendahl
README.md+44−4
@@ -101,14 +101,18 @@ Crush can use LSPs for additional context to help inform its decisions, just lik
101
101
102### MCPs
102### MCPs
103
103
104−Crush can also use MCPs for additional context. Add LSPs to the config like so:
104+Crush supports Model Context Protocol (MCP) servers through three transport types: `stdio` for command-line servers, `http` for HTTP endpoints, and `sse` for Server-Sent Events. Environment variable expansion is supported using `$(echo $VAR)` syntax.
105
105
106```json
106```json
107{
107{
108 "mcp": {
108 "mcp": {
109− "context7": {
109+ "filesystem": {
110− "url": "https://mcp.context7.com/mcp",
111− "type": "http"
110+ "type": "stdio",
111+ "command": "node",
112+ "args": ["/path/to/mcp-server.js"],
113+ "env": {
114+ "NODE_ENV": "production"
115+ }
112 },
116 },
113 "github": {
117 "github": {
114 "type": "http",
118 "type": "http",
@@ -116,11 +120,47 @@ Crush can also use MCPs for additional context. Add LSPs to the config like so:
116 "headers": {
120 "headers": {
117 "Authorization": "$(echo Bearer $GH_MCP_TOKEN)"
121 "Authorization": "$(echo Bearer $GH_MCP_TOKEN)"
118 }
122 }
123+ },
124+ "streaming-service": {
125+ "type": "sse",
126+ "url": "https://example.com/mcp/sse",
127+ "headers": {
128+ "API-Key": "$(echo $API_KEY)"
129+ }
119 }
130 }
120 }
131 }
121}
132}
122```
133```
123
134
135+### Logging
136+
137+Enable debug logging with the `-d` flag or in config. View logs with `crush logs`. Logs are stored in `.crush/logs/crush.log`.
138+
139+```bash
140+# Run with debug logging
141+crush -d
142+
143+# View last 1000 lines
144+crush logs
145+
146+# Follow logs in real-time
147+crush logs -f
148+
149+# Show last 500 lines
150+crush logs -t 500
151+```
152+
153+Add to your `crush.json` config file:
154+
155+```json
156+{
157+ "options": {
158+ "debug": true,
159+ "debug_lsp": true
160+ }
161+}
162+```
163+
124### OpenAI-Compatible APIs
164### OpenAI-Compatible APIs
125
165
126Crush supports all OpenAI-compatible APIs. Here's an example configuration for Deepseek, which uses an OpenAI-compatible API. Don't forget to set `DEEPSEEK_API_KEY` in your environment.
166Crush supports all OpenAI-compatible APIs. Here's an example configuration for Deepseek, which uses an OpenAI-compatible API. Don't forget to set `DEEPSEEK_API_KEY` in your environment.