Skip to content

Commit e5f1ee6

Browse files
docs: Fix broken links in MCP documentation
- Fix relative paths to reference correct documentation files - Update pkg.go.dev links to use valid version format - Ensure all internal links point to existing files Resolves linkspector issues identified in CI. Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
1 parent 92f6a32 commit e5f1ee6

File tree

4 files changed

+21
-9
lines changed

4 files changed

+21
-9
lines changed

docs/ai-coder/mcp-server.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Coder's MCP server enables AI assistants to interact with Coder workspaces and i
1212
- **Agent Activity**: Monitor AI agent operations and history
1313

1414
> [!NOTE]
15-
> See our [toolsdk documentation](https://pkg.go.dev/github.com/coder/coder/v2@latest/codersdk/toolsdk#pkg-variables) for a complete list of tools included in the MCP server.
15+
> See our [toolsdk documentation](https://pkg.go.dev/github.com/coder/coder/v2/codersdk/toolsdk#pkg-variables) for a complete list of tools included in the MCP server.
1616
1717
## Architecture
1818

@@ -27,6 +27,7 @@ Coder provides two MCP server modes to support different AI assistant architectu
2727
The local MCP server runs on your machine and communicates with AI assistants through standard input/output. This mode is ideal for desktop applications and local development tools.
2828

2929
**Automatic Configuration**:
30+
3031
```sh
3132
# First authenticate with Coder
3233
coder login https://coder.example.com
@@ -37,6 +38,7 @@ coder exp mcp configure cursor
3738
```
3839

3940
**Manual Server Start**:
41+
4042
```sh
4143
# Start MCP server for manual configuration
4244
coder exp mcp server
@@ -49,6 +51,7 @@ coder exp mcp server
4951
The HTTP MCP server runs on your Coder deployment and provides web-based access for browser-based AI assistants.
5052

5153
**Enable HTTP MCP Server**:
54+
5255
```sh
5356
# Enable experimental features
5457
CODER_EXPERIMENTS="oauth2,mcp-server-http" coder server
@@ -66,6 +69,7 @@ CODER_EXPERIMENTS="oauth2,mcp-server-http" coder server
6669
The Coder MCP server exposes a comprehensive set of tools through the Model Context Protocol. These tools are automatically available to any connected AI assistant.
6770

6871
### Workspace Tools
72+
6973
- `list_workspaces` - List all accessible workspaces
7074
- `create_workspace` - Create new workspaces from templates
7175
- `start_workspace` - Start stopped workspaces
@@ -74,21 +78,24 @@ The Coder MCP server exposes a comprehensive set of tools through the Model Cont
7478
- `get_workspace_status` - Check workspace status and resource usage
7579

7680
### Command Execution Tools
81+
7782
- `execute_command` - Run commands in workspace terminals
7883
- `get_command_output` - Retrieve command execution results
7984
- `list_processes` - List running processes in workspaces
8085

8186
### File System Tools
87+
8288
- `read_file` - Read file contents from workspaces
8389
- `write_file` - Write files to workspace file systems
8490
- `list_directory` - List directory contents
8591

8692
### Template and Resource Tools
93+
8794
- `list_templates` - List available workspace templates
8895
- `get_template_info` - Get detailed template information
8996
- `list_template_versions` - List template version history
9097

91-
For the complete and up-to-date list of available tools, see the [toolsdk documentation](https://pkg.go.dev/github.com/coder/coder/v2@latest/codersdk/toolsdk#pkg-variables).
98+
For the complete and up-to-date list of available tools, see the [toolsdk documentation](https://pkg.go.dev/github.com/coder/coder/v2/codersdk/toolsdk#pkg-variables).
9299

93100
## Configuration Options
94101

@@ -125,12 +132,14 @@ export CODER_MCP_LOG_LEVEL=debug
125132
## Security Considerations
126133

127134
### Authentication and Authorization
135+
128136
- **Local Mode**: Uses Coder CLI credentials and user permissions
129137
- **HTTP Mode**: Requires OAuth2 authentication with proper scopes
130138
- **Permission Inheritance**: MCP operations inherit the authenticated user's Coder permissions
131139
- **Audit Logging**: All MCP operations are logged through Coder's audit system
132140

133141
### Best Practices
142+
134143
- Regularly rotate authentication credentials
135144
- Monitor MCP usage through Coder's audit logs
136145
- Use workspace templates with appropriate security configurations
@@ -142,16 +151,19 @@ export CODER_MCP_LOG_LEVEL=debug
142151
### Common Issues
143152

144153
**MCP Server Won't Start**:
154+
145155
- Verify Coder CLI authentication: `coder whoami`
146156
- Check experimental features are enabled for HTTP mode
147157
- Review server logs for error messages
148158

149159
**AI Assistant Can't Connect**:
160+
150161
- Verify MCP server is running and accessible
151162
- Check authentication credentials and permissions
152163
- Ensure network connectivity to Coder deployment
153164

154165
**Permission Denied Errors**:
166+
155167
- Verify user has appropriate workspace permissions
156168
- Check Coder RBAC settings
157169
- Ensure OAuth2 scopes are correctly configured (HTTP mode)

docs/mcp/claude-desktop.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -333,5 +333,5 @@ For Claude Desktop-specific MCP issues:
333333
334334
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
335335
- [Claude Desktop User Guide](https://docs.anthropic.com/claude/docs/claude-desktop)
336-
- [Coder CLI Reference](../../reference/cli.md)
337-
- [Workspace Templates Guide](../../tutorials/templates.md)
336+
- [Coder CLI Reference](../reference/cli/index.md)
337+
- [Workspace Templates Guide](../tutorials/template-from-scratch.md)

docs/mcp/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Coder MCP inherits Coder's robust security model:
112112
113113
## Available Tools and Capabilities
114114
115-
The Coder MCP server provides access to a comprehensive set of tools. See the [toolsdk documentation](https://pkg.go.dev/github.com/coder/coder/v2@latest/codersdk/toolsdk#pkg-variables) for the complete list of available tools.
115+
The Coder MCP server provides access to a comprehensive set of tools. See the [toolsdk documentation](https://pkg.go.dev/github.com/coder/coder/v2/codersdk/toolsdk#pkg-variables) for the complete list of available tools.
116116
117117
## Next Steps
118118

docs/mcp/web-agents.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ For enterprise deployments:
324324
- Learn about [AI coding best practices](../ai-coder/best-practices.md)
325325
- Set up [Coder Tasks](../ai-coder/tasks.md) for background operations
326326
- Review [security considerations](../ai-coder/security.md) for AI development
327-
- Check out [OAuth2 provider documentation](../../admin/integrations/oauth2-provider.md)
327+
- Check out [OAuth2 provider documentation](../admin/integrations/oauth2-provider.md)
328328

329329
## Support
330330

@@ -339,6 +339,6 @@ For web agent MCP issues:
339339
## Additional Resources
340340
341341
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
342-
- [Coder OAuth2 Provider Guide](../../admin/integrations/oauth2-provider.md)
343-
- [Coder API Documentation](../../reference/api.md)
344-
- [Web Security Best Practices](../../admin/security.md)
342+
- [Coder OAuth2 Provider Guide](../admin/integrations/oauth2-provider.md)
343+
- [Coder API Documentation](../reference/api/index.md)
344+
- [Web Security Best Practices](../admin/security/index.md)

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy