Skip to content

Commit 92f6a32

Browse files
blink-so[bot]matifali
blink-so[bot]
and
matifali
committed
docs: Fix markdown linting errors in MCP documentation
- Add language specifications to code blocks - Fix ordered list numbering issues - Ensure all markdown follows project style guidelines Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
1 parent a36a72e commit 92f6a32

File tree

7 files changed

+196
-146
lines changed

7 files changed

+196
-146
lines changed

‎docs/mcp/claude-desktop.md

Lines changed: 38 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ coder login https://coder.example.com
2020

2121
# Configure Claude Desktop to use Coder MCP
2222
coder exp mcp configure claude-desktop
23-
```
23+
```txt
2424
2525
This command will:
2626
- Locate your Claude Desktop configuration file
@@ -36,7 +36,7 @@ If automatic configuration doesn't work, you can manually set up MCP:
3636
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
3737
- **Linux**: `~/.config/Claude/claude_desktop_config.json`
3838
39-
2. **Add Coder MCP server configuration**:
39+
1. **Add Coder MCP server configuration**:
4040
```json
4141
{
4242
"mcpServers": {
@@ -49,7 +49,7 @@ If automatic configuration doesn't work, you can manually set up MCP:
4949
}
5050
```
5151

52-
3. **Restart Claude Desktop** to load the new configuration.
52+
1. **Restart Claude Desktop** to load the new configuration.
5353

5454
## Using Coder MCP with Claude Desktop
5555

@@ -58,18 +58,21 @@ Once configured, Claude can interact with your Coder workspaces through MCP, pro
5858
### Available Capabilities
5959

6060
**Workspace Management**:
61+
6162
- List and inspect your Coder workspaces
6263
- Create new workspaces from templates
6364
- Start, stop, and manage workspace lifecycle
6465
- Monitor workspace status and resource usage
6566

6667
**Development Operations**:
68+
6769
- Execute commands in remote workspaces
6870
- Run build scripts, tests, and deployment processes
6971
- Install packages and manage dependencies
7072
- Access workspace terminals and file systems
7173

7274
**AI-Assisted Development**:
75+
7376
- Analyze code in your actual development environments
7477
- Generate code that works with your specific workspace setup
7578
- Debug issues using live workspace context
@@ -78,43 +81,44 @@ Once configured, Claude can interact with your Coder workspaces through MCP, pro
7881
### Example Interactions
7982

8083
**Project setup and initialization**:
81-
```
84+
85+
```txt
8286
You: "I need to set up a new Python web application with FastAPI. Can you create a workspace and set up the project structure?"
8387
8488
Claude: I'll help you create a new Coder workspace and set up a FastAPI project. Let me:
8589
1. Create a new workspace using a Python template
86-
2. Install FastAPI and dependencies
87-
3. Set up the basic project structure
90+
1. Install FastAPI and dependencies
91+
1. Set up the basic project structure
8892
4. Create a simple API endpoint to get you started
8993
9094
[Claude uses MCP to create workspace, install dependencies, and set up project]
91-
```
95+
```txt
9296
9397
**Debugging and troubleshooting**:
94-
```
98+
```txt
9599
You: "My application in the backend workspace is failing to start. Can you help me debug it?"
96100
97101
Claude: I'll help you debug the startup issue. Let me:
98102
1. Check the workspace status
99-
2. Examine the application logs
100-
3. Verify the configuration
103+
1. Examine the application logs
104+
1. Verify the configuration
101105
4. Identify and fix the issue
102106
103107
[Claude uses MCP to access workspace, check logs, and diagnose the problem]
104-
```
108+
```txt
105109
106110
**Code review and optimization**:
107-
```
111+
```txt
108112
You: "Can you review the code in my frontend workspace and suggest improvements?"
109113
110114
Claude: I'll review your frontend code and provide suggestions. Let me:
111115
1. Access your workspace and examine the codebase
112-
2. Analyze the code structure and patterns
113-
3. Identify potential improvements
116+
1. Analyze the code structure and patterns
117+
1. Identify potential improvements
114118
4. Suggest specific optimizations
115119
116120
[Claude uses MCP to access code and provide detailed review]
117-
```
121+
```txt
118122
119123
## Claude Desktop-Specific Features
120124
@@ -159,7 +163,7 @@ Customize the MCP server behavior for Claude Desktop:
159163
}
160164
}
161165
}
162-
```
166+
```txt
163167
164168
### Environment Variables
165169
@@ -174,7 +178,7 @@ export CODER_MCP_TIMEOUT=120s
174178
175179
# Start Claude Desktop with custom environment
176180
open -a "Claude Desktop"
177-
```
181+
```txt
178182
179183
## Troubleshooting
180184
@@ -186,54 +190,59 @@ open -a "Claude Desktop"
186190
coder workspaces list
187191
```
188192

189-
2. **Test MCP server manually**:
193+
1. **Test MCP server manually**:
194+
190195
```bash
191196
coder exp mcp server --log-level debug
192197
```
193198

194-
3. **Check Claude Desktop configuration**:
199+
1. **Check Claude Desktop configuration**:
195200
- Verify the configuration file exists and has correct syntax
196201
- Ensure the file path is correct for your operating system
197202
- Check Claude Desktop's logs for MCP-related errors
198203

199204
### Claude Not Recognizing MCP Tools
200205

201206
1. **Restart Claude Desktop**: A full restart is often needed after configuration changes
202-
2. **Check MCP server status**: Ensure the MCP server is running and accessible
203-
3. **Verify permissions**: Ensure Claude Desktop has necessary permissions to execute the Coder CLI
207+
1. **Check MCP server status**: Ensure the MCP server is running and accessible
208+
1. **Verify permissions**: Ensure Claude Desktop has necessary permissions to execute the Coder CLI
204209

205210
### Performance Issues
206211

207212
1. **Optimize workspace resources**: Ensure workspaces have adequate resources
208-
2. **Check network connectivity**: Verify stable connection to your Coder deployment
209-
3. **Monitor MCP timeouts**: Adjust timeout settings for long-running operations
213+
1. **Check network connectivity**: Verify stable connection to your Coder deployment
214+
1. **Monitor MCP timeouts**: Adjust timeout settings for long-running operations
210215

211216
### Authentication Problems
212217

213218
1. **Re-authenticate with Coder**:
219+
214220
```bash
215221
coder login https://coder.example.com
216222
```
217223

218-
2. **Check token expiration**: Verify your Coder authentication token is still valid
219-
3. **Verify permissions**: Ensure your user has appropriate workspace permissions
224+
1. **Check token expiration**: Verify your Coder authentication token is still valid
225+
1. **Verify permissions**: Ensure your user has appropriate workspace permissions
220226

221227
## Best Practices
222228

223229
### Security
230+
224231
- Keep your Coder CLI credentials secure and up to date
225232
- Use workspace templates with appropriate security configurations
226233
- Regularly review Claude's access to your workspaces
227234
- Enable audit logging for compliance and monitoring
228235
- Implement proper secret management in workspaces
229236

230237
### Effective AI Interaction
238+
231239
- Be specific about which workspace you want Claude to work with
232240
- Provide context about your project goals and constraints
233241
- Ask Claude to explain its actions when working with your workspaces
234242
- Use iterative conversations to refine development tasks
235243

236244
### Development Workflow
245+
237246
- Create standardized workspace templates for different project types
238247
- Use consistent naming conventions for workspaces and projects
239248
- Establish clear boundaries for what Claude should and shouldn't modify
@@ -270,7 +279,7 @@ resource "coder_workspace" "claude_dev" {
270279
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
271280
EOF
272281
}
273-
```
282+
```txt
274283
275284
### Automated Workflows
276285
@@ -293,7 +302,7 @@ coder ssh my-project -- 'echo "Workspace ready"'
293302
coder ssh my-project -- 'git init && npm init -y'
294303
295304
echo "Project setup complete!"
296-
```
305+
```txt
297306
298307
### Integration with Development Tools
299308
@@ -315,8 +324,8 @@ Combine Claude Desktop with other development tools:
315324
For Claude Desktop-specific MCP issues:
316325
317326
1. Check [Claude Desktop documentation](https://docs.anthropic.com/claude/docs/claude-desktop) for MCP support
318-
2. [Contact Coder Support](https://coder.com/contact) for Coder MCP server issues
319-
3. [Join our Discord](https://discord.gg/coder) for community support
327+
1. [Contact Coder Support](https://coder.com/contact) for Coder MCP server issues
328+
1. [Join our Discord](https://discord.gg/coder) for community support
320329
4. [Report bugs](https://github.com/coder/coder/issues) on the Coder GitHub repository
321330
5. Contact [Anthropic Support](https://support.anthropic.com/) for Claude Desktop-specific issues
322331

‎docs/mcp/cursor.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ coder login https://coder.example.com
2020

2121
# Configure Cursor to use Coder MCP
2222
coder exp mcp configure cursor
23-
```
23+
```txt
2424
2525
This command will:
2626
- Locate your Cursor configuration directory
@@ -36,7 +36,7 @@ If automatic configuration doesn't work, you can manually set up MCP:
3636
- **Windows**: `%APPDATA%\Cursor\User\globalStorage\mcp.json`
3737
- **Linux**: `~/.config/Cursor/User/globalStorage/mcp.json`
3838
39-
2. **Add Coder MCP server configuration**:
39+
1. **Add Coder MCP server configuration**:
4040
```json
4141
{
4242
"mcpServers": {
@@ -50,7 +50,7 @@ If automatic configuration doesn't work, you can manually set up MCP:
5050
}
5151
```
5252
53-
3. **Restart Cursor** to load the new configuration.
53+
1. **Restart Cursor** to load the new configuration.
5454
5555
## Using Coder MCP in Cursor
5656
@@ -59,41 +59,45 @@ Once configured, Cursor's AI can interact with your Coder workspaces through MCP
5959
### Available Capabilities
6060
6161
**Workspace Management**:
62+
6263
- List all your Coder workspaces
6364
- Create new workspaces from templates
6465
- Start, stop, and delete workspaces
6566
- Check workspace status and resource usage
6667
6768
**Command Execution**:
69+
6870
- Run commands in any workspace
6971
- Execute build scripts and tests
7072
- Install dependencies and packages
7173
- Manage development processes
7274
7375
**Environment Interaction**:
76+
7477
- Access workspace file systems
7578
- Monitor running processes
7679
- Check environment variables and configuration
7780
7881
### Example Interactions
7982
8083
**Creating a development environment**:
81-
```
84+
85+
```txt
8286
You: "I need a new React workspace for my frontend project"
8387
Cursor AI: Creates a new Coder workspace using a React template, installs dependencies, and sets up the development environment
84-
```
88+
```txt
8589
8690
**Running tests across workspaces**:
87-
```
91+
```txt
8892
You: "Run the test suite in my backend workspace"
8993
Cursor AI: Connects to your backend workspace via MCP and executes the test commands, showing results
90-
```
94+
```txt
9195
9296
**Managing multiple environments**:
93-
```
97+
```txt
9498
You: "Show me the status of all my workspaces and start the ones that are stopped"
9599
Cursor AI: Lists workspace statuses and starts any stopped workspaces
96-
```
100+
```txt
97101
98102
## Cursor-Specific Features
99103
@@ -138,7 +142,7 @@ You can customize the MCP server behavior in your configuration:
138142
}
139143
}
140144
}
141-
```
145+
```txt
142146
143147
### Environment Variables
144148
@@ -150,7 +154,7 @@ export CODER_MCP_LOG_LEVEL=debug
150154
151155
# Increase timeout for long-running operations
152156
export CODER_MCP_TIMEOUT=120s
153-
```
157+
```txt
154158
155159
## Troubleshooting
156160
@@ -161,50 +165,55 @@ export CODER_MCP_TIMEOUT=120s
161165
coder whoami
162166
```
163167
164-
2. **Test MCP server manually**:
168+
1. **Test MCP server manually**:
169+
165170
```bash
166171
coder exp mcp server --help
167172
```
168173
169-
3. **Verify Cursor configuration**:
174+
1. **Verify Cursor configuration**:
170175
- Check that the MCP configuration file exists
171176
- Ensure the file has correct JSON syntax
172177
- Restart Cursor after making changes
173178
174179
### Cursor AI Not Recognizing MCP
175180
176181
1. **Check Cursor version**: Ensure you're using a version that supports MCP
177-
2. **Restart Cursor**: Sometimes a full restart is needed
178-
3. **Check Cursor logs**: Look for MCP-related errors in Cursor's developer console
182+
1. **Restart Cursor**: Sometimes a full restart is needed
183+
1. **Check Cursor logs**: Look for MCP-related errors in Cursor's developer console
179184
180185
### Permission Issues
181186
182187
1. **Verify Coder permissions**: Ensure your user can create and manage workspaces
183-
2. **Check authentication**: Re-authenticate if needed:
188+
1. **Check authentication**: Re-authenticate if needed:
189+
184190
```bash
185191
coder login https://coder.example.com
186192
```
187193
188194
### Performance Issues
189195
190196
1. **Optimize workspace templates**: Use lightweight templates for faster startup
191-
2. **Monitor resource usage**: Check workspace CPU and memory allocation
192-
3. **Adjust MCP timeout**: Increase timeout for slow operations
197+
1. **Monitor resource usage**: Check workspace CPU and memory allocation
198+
1. **Adjust MCP timeout**: Increase timeout for slow operations
193199
194200
## Best Practices
195201
196202
### Security
203+
197204
- Keep your Coder CLI credentials secure
198205
- Use workspace templates with appropriate security configurations
199206
- Regularly review AI assistant access patterns
200207
- Enable audit logging for compliance requirements
201208
202209
### Performance
210+
203211
- Use Coder workspace templates optimized for your development stack
204212
- Consider workspace resource allocation based on AI workload requirements
205213
- Implement workspace auto-stop policies to manage costs
206214
207215
### Development Workflow
216+
208217
- Create project-specific workspace templates
209218
- Use consistent naming conventions for workspaces
210219
- Leverage Coder's collaboration features for team development
@@ -230,7 +239,7 @@ resource "coder_workspace" "dev" {
230239
npm install -g @cursor/cli
231240
EOF
232241
}
233-
```
242+
```txt
234243
235244
### Integration with CI/CD
236245
@@ -251,6 +260,6 @@ Use Cursor + Coder MCP for automated development workflows:
251260
For Cursor-specific MCP issues:
252261
253262
1. Check [Cursor's MCP documentation](https://docs.cursor.com/mcp) (when available)
254-
2. [Contact Coder Support](https://coder.com/contact) for Coder MCP server issues
255-
3. [Join our Discord](https://discord.gg/coder) for community support
263+
1. [Contact Coder Support](https://coder.com/contact) for Coder MCP server issues
264+
1. [Join our Discord](https://discord.gg/coder) for community support
256265
4. [Report bugs](https://github.com/coder/coder/issues) on GitHub

0 commit comments

Comments
 (0)