diff --git a/registry/coder/modules/cursor/README.md b/registry/coder/modules/cursor/README.md index 3551e831b..c4c169d29 100644 --- a/registry/coder/modules/cursor/README.md +++ b/registry/coder/modules/cursor/README.md @@ -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 } ``` @@ -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" } @@ -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" +} ```