Skip to content

chore(cursor): update mcp example to use GitHub #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 18, 2025
Merged

chore(cursor): update mcp example to use GitHub #330

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d3613e
udpate mcp examp[le to use github
matifali Aug 15, 2025
2ef8c8b
Bump Cursor module version to 1.3.1
matifali Aug 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions registry/coder/modules/cursor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder)
module "cursor" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/cursor/coder"
version = "1.3.0"
version = "1.3.1"
agent_id = coder_agent.example.id
}
```
Expand All @@ -29,7 +29,7 @@ module "cursor" {
module "cursor" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/cursor/coder"
version = "1.3.0"
version = "1.3.1"
agent_id = coder_agent.example.id
folder = "/home/coder/project"
}
Expand All @@ -39,23 +39,29 @@ module "cursor" {

Provide a JSON-encoded string via the `mcp` input. When set, the module writes the value to `~/.cursor/mcp.json` using a `coder_script` on workspace start.

The following example configures Cursor to use the GitHub MCP server with authentication facilitated by the [`coder_external_auth`](https://coder.com/docs/admin/external-auth#configure-a-github-oauth-app) resource.

```tf
module "cursor" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/cursor/coder"
version = "1.3.0"
version = "1.3.1"
agent_id = coder_agent.example.id
folder = "/home/coder/project"
mcp = jsonencode({
mcpServers = {
coder = {
command = "coder"
args = ["exp", "mcp", "server"]
env = {
CODER_MCP_APP_STATUS_SLUG = "cursor"
CODER_MCP_AI_AGENTAPI_URL = "http://localhost:3284"
}
"github" : {
"url" : "https://api.githubcopilot.com/mcp/",
"headers" : {
"Authorization" : "Bearer ${data.coder_external_auth.github.access_token}",
},
"type" : "http"
}
}
})
}

data "coder_external_auth" "github" {
id = "github"
}
```