Skip to content

Commit 032a04d

Browse files
docs: update README for Copilot CLI module with new MCP server configurations and usage notes
1 parent b3dda60 commit 032a04d

File tree

1 file changed

+27
-4
lines changed
  • registry/coder-labs/modules/copilot-cli

1 file changed

+27
-4
lines changed

registry/coder-labs/modules/copilot-cli/README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,25 @@ module "copilot_cli" {
7878
7979
mcp_config = jsonencode({
8080
mcpServers = {
81-
custom_server = {
82-
command = "npx"
83-
args = ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/allowed/files"]
81+
filesystem = {
82+
command = "npx"
83+
args = ["-y", "@modelcontextprotocol/server-filesystem", "/home/coder/workspace"]
84+
description = "Provides file system access to the workspace"
85+
name = "Filesystem"
86+
timeout = 3000
87+
type = "local"
88+
tools = ["*"]
89+
trust = true
90+
}
91+
playwright = {
92+
command = "npx"
93+
args = ["-y", "@playwright/mcp@latest", "--headless", "--isolated"]
94+
description = "Browser automation for testing and previewing changes"
95+
name = "Playwright"
96+
timeout = 5000
97+
type = "local"
98+
tools = ["*"]
99+
trust = false
84100
}
85101
}
86102
})
@@ -93,6 +109,12 @@ module "copilot_cli" {
93109
}
94110
```
95111

112+
> [!NOTE]
113+
> GitHub Copilot CLI does not automatically install MCP servers. You have two options:
114+
>
115+
> - Use `npx -y` in the MCP config (shown above) to auto-install on each run
116+
> - Pre-install MCP servers in `pre_install_script` for faster startup (e.g., `npm install -g @modelcontextprotocol/server-filesystem`)
117+
96118
### Direct Token Authentication
97119

98120
```tf
@@ -150,7 +172,8 @@ The module supports multiple authentication methods (in priority order):
150172
2. **Coder External Auth** - Automatic if GitHub external auth is configured in Coder
151173
3. **Interactive** - Copilot CLI prompts for login via `/login` command if no auth found
152174

153-
> **Note**: OAuth tokens work best with Copilot CLI. Personal Access Tokens may have limited functionality.
175+
> [!NOTE]
176+
> OAuth tokens work best with Copilot CLI. Personal Access Tokens may have limited functionality.
154177
155178
## Session Resumption
156179

0 commit comments

Comments
 (0)