feat(cursor-cli): add Cursor CLI module #309

matifali · 2025-08-08T18:12:45Z

Summary

Add new module registry/coder-labs/modules/cursor-cli to run Cursor Agent CLI directly (no AgentAPI)
Interactive chat by default; supports non-interactive mode (-p) with output-format
Supports model (-m) and force (-f) flags, initial prompt, and CURSOR_API_KEY
Merges MCP settings into ~/.cursor/settings.json
Installs via npm, bootstrapping Node via NVM if missing (mirrors gemini approach)
Adds Terraform-native tests (.tftest.hcl); all pass locally

Test plan

From module dir:
- terraform init -upgrade
- terraform test -verbose
Expect 4 tests passing covering defaults, flag plumbing, and MCP settings injection
Basic smoke run: ensure cursor-agent is on PATH or set install_cursor_cli=true

…CP settings, model/force) - Runs `cursor-agent` directly (no AgentAPI); interactive chat by default - Supports non-interactive prints (-p) with output-format, model (-m), force (-f) - Merges MCP settings into ~/.cursor/settings.json - Installs via npm (uses nvm if needed); terraform tests added

…only - mcp_json -> <folder>/.cursor/mcp.json (optional) - rules_files map -> <folder>/.cursor/rules/* (optional); link rules docs - always -p; default output_format=json; README updates

…itional_settings; simplify non-interactive run

…anup; remove unused options

…and rules files

- Introduced variables for optional pre-install and post-install scripts in the module. - Updated the main script to execute these scripts if provided. - Enhanced tests to validate the embedding of the new scripts.

…and add post-install wait script - Modified main.tf to pass the folder variable to pre-install and post-install scripts. - Added a new post_install_script in README to wait for the repository to be ready before proceeding.

- Removed the `-p` argument and the conditional for `OUTPUT_FORMAT` from the script to streamline execution and avoid unnecessary options.

….sh script - Reintroduced the `-p` argument and the conditional for `OUTPUT_FORMAT` to enhance script functionality and allow for more flexible execution options.

…t arguments - Eliminated the `output_format` variable from main.tf and removed associated logic from start.sh to simplify the script and reduce complexity.

registry/coder/modules/claude-code/main.test.ts

registry/coder-labs/modules/cursor-cli/main.test.ts

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

Co-authored-by: DevCats <christofer@coder.com>

DevelopmentCats · 2025-08-13T14:05:12Z

Waiting on coder/agentapi#54 to merge and then this LGTM

35C4n0r · 2025-08-13T20:32:12Z

@matifali added support for agentapi, do we still want to keep the support for coder_script in here ?

matifali · 2025-08-13T23:56:12Z

I think we should support 2 modes one where the session is interactive through AgnetAPi, the other un interactive session where the agent starts working with the first prompt there are options -p to support that.

I will let you choose if we need a coder_script here.

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

registry/coder-labs/modules/cursor-cli/main.tf

35C4n0r · 2025-08-14T07:37:03Z

@matifali I had to add this line to readme

Cursor CLI dosen't seem fully compatible with MCPs, so Coder tasks and Coder MCP will not work with this module.

The cli executes the tool call and then just stops, and doesn't do any further processing. Have spent good amount of time trying to make this work, will keep an eye out for future releases and update it as needed.
Additionally it dosen't respect the env variable, had to find a hack to even make the tools discoverable.

35C4n0r · 2025-08-14T07:44:18Z

@DevelopmentCats please give this a review, and let me know if it needs any other changes.

Copilot

Pull Request Overview

This PR introduces a new Terraform module cursor-cli that enables running Cursor Agent CLI directly within Coder workspaces without using AgentAPI. The module provides interactive chat by default with support for non-interactive mode, model selection, and various configuration options.

Key changes:

New Terraform module with comprehensive variable configuration including AI prompts, MCP settings, and CLI flags
Installation script that sets up Cursor CLI via official installer and configures MCP/rules integration
Start script that handles command execution with proper argument passing and AgentAPI server integration

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
main.tf	Core module definition with variables, AgentAPI integration, and script orchestration
scripts/install.sh	Installation logic for Cursor CLI, MCP configuration, and rules file setup
scripts/start.sh	Runtime script for executing cursor-agent with proper argument handling
testdata/cursor-cli-mock.sh	Mock script for testing cursor-agent behavior
main.test.ts	Comprehensive test suite covering installation, configuration, and flag handling
cursor-cli.tftest.hcl	Terraform native tests for validating script generation and variable propagation
README.md	Documentation with usage examples and configuration guidance

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

registry/coder-labs/modules/cursor-cli/testdata/cursor-cli-mock.sh

registry/coder-labs/modules/cursor-cli/scripts/start.sh

Copilot · 2025-08-14T13:49:01Z

registry/coder-labs/modules/cursor-cli/main.tf

+  default     = "v0.4.0"
+}
+
+# Running mode is non-interactive by design for automation.


This comment appears to be incorrect or outdated. The module supports both interactive and non-interactive modes, with interactive being the default according to the PR description.

Suggested change

# Running mode is non-interactive by design for automation.

# Module supports both interactive and non-interactive modes; interactive is the default.

registry/coder-labs/modules/cursor-cli/cursor-cli.tftest.hcl

Copilot · 2025-08-14T13:49:02Z

registry/coder-labs/modules/cursor-cli/cursor-cli.tftest.hcl

+    error_message = "Expected OUTPUT_FORMAT to be propagated"
+  }
+
+  assert {


This test references a non-existent resource and variable. The module doesn't have an 'output_format' variable defined in main.tf.

Suggested change

assert {

ai_prompt = "refactor the auth module to use JWT tokens"

}

assert {

Copilot · 2025-08-14T13:49:02Z

registry/coder-labs/modules/cursor-cli/cursor-cli.tftest.hcl

+
+  assert {
+    condition     = can(regex("AI_PROMPT='refactor the auth module to use JWT tokens'", resource.coder_script.cursor_cli.script))
+    error_message = "Expected ai_prompt to be propagated via AI_PROMPT"


This test references a non-existent resource 'coder_script.cursor_cli' and incorrect variable name format. The actual variable is 'ai_prompt' not 'AI_PROMPT'.

Suggested change

error_message = "Expected ai_prompt to be propagated via AI_PROMPT"

condition = can(regex("ai_prompt='refactor the auth module to use JWT tokens'", resource.coder_script.cursor_cli.script))

error_message = "Expected ai_prompt to be propagated via ai_prompt"

matifali · 2025-08-14T13:52:30Z

@35C4n0r I filed an issue and someone shared that having mcp.json works if it is in the same directory where the Cursor agent binary is run.

https://forum.cursor.com/t/cursor-cli-not-respecting-global-mcp-and-rules-configurations/129372

DevelopmentCats · 2025-08-14T13:53:23Z

@matifali I had to add this line to readme

Cursor CLI dosen't seem fully compatible with MCPs, so Coder tasks and Coder MCP will not work with this module.

The cli executes the tool call and then just stops, and doesn't do any further processing. Have spent good amount of time trying to make this work, will keep an eye out for future releases and update it as needed. Additionally it dosen't respect the env variable, had to find a hack to even make the tools discoverable.

Did you try it the way that they recommend in the docs? I know the mcp servers work in cursor itself, and its labeled as supported in their docs.

MCP
Agent supports [MCP (Model Context Protocol)](https://docs.cursor.com/en/tools/mcp) for extended functionality and integrations. The CLI will automatically detect and respect your mcp.json configuration file, enabling the same MCP servers and tools that you’ve configured for the IDE.

https://docs.cursor.com/en/cli/using

Also the format for how mcp.json needs to be written is here https://docs.cursor.com/en/context/mcp

{
  "mcpServers": {
    "server-name": {
      "command": "npx",
      "args": ["-y", "mcp-server"],
      "env": {
        "API_KEY": "value"
      }
    }
  }
}

35C4n0r · 2025-08-14T13:56:19Z

@DevelopmentCats yes, I've tried that, unfortunately neither does it respect the env, it also stops processing after the tool call, the same config, prompt and tool calls works perfectly fine with Cursor Desktop.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…k.sh Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

35C4n0r · 2025-08-14T14:09:35Z

@35C4n0r I filed an issue and someone shared that having mcp.json works if it is in the same directory where the Cursor agent binary is run.

https://forum.cursor.com/t/cursor-cli-not-respecting-global-mcp-and-rules-configurations/129372

@matifali already figured this part out we are also using the folder/.cursor/mcp.json, from the screenshot in his comment I think he is using mcp.json in the project specific dir.
As of now, this:

stops processing after the tool call

is the only part that's keeping us from releasing this successfully.

matifali marked this pull request as draft August 8, 2025 18:17

matifali added 6 commits August 8, 2025 23:48

feat(cursor-cli): add project MCP and rules support; non-interactive …

7483c77

…only - mcp_json -> <folder>/.cursor/mcp.json (optional) - rules_files map -> <folder>/.cursor/rules/* (optional); link rules docs - always -p; default output_format=json; README updates

chore(cursor-cli): remove Bun test; terraform tests only

a3aa1cf

refactor(cursor-cli): drop extra_args, binary_name, base_command, add…

a075139

…itional_settings; simplify non-interactive run

chore: format cursor-cli module and tests

2a65de4

feat(cursor-cli): configure Coder MCP status slug in module; docs cle…

5e3f555

…anup; remove unused options

chore(cursor-cli): move env to coder_env; update scripts

6f46bc9

matifali changed the title ~~feat(cursor-cli): add Cursor Agent CLI module (no AgentAPI, interactive by default)~~ feat(cursor-cli): add Cursor Agent CLI module Aug 8, 2025

matifali changed the title ~~feat(cursor-cli): add Cursor Agent CLI module~~ feat(cursor-cli): add Cursor CLI module Aug 8, 2025

matifali added 9 commits August 9, 2025 01:55

wip

ce902f6

docs(cursor-cli): enhance README with examples for MCP configuration …

df31818

…and rules files

feat(cursor-cli): add pre-install and post-install script support

d8b9b2a

- Introduced variables for optional pre-install and post-install scripts in the module. - Updated the main script to execute these scripts if provided. - Enhanced tests to validate the embedding of the new scripts.

feat(cursor-cli): add ai_prompt variable

079ff1f

feat(cursor-cli): add output for app ID in main.tf

496efad

refactor(cursor-cli): comment out unused arguments in start.sh script

0a87206

- Removed the `-p` argument and the conditional for `OUTPUT_FORMAT` from the script to streamline execution and avoid unnecessary options.

refactor(cursor-cli): restore previously commented arguments in start…

8b6b659

….sh script - Reintroduced the `-p` argument and the conditional for `OUTPUT_FORMAT` to enhance script functionality and allow for more flexible execution options.

refactor(cursor-cli): remove output_format variable and related scrip…

4edcb00

…t arguments - Eliminated the `output_format` variable from main.tf and removed associated logic from start.sh to simplify the script and reduce complexity.

DevelopmentCats reviewed Aug 9, 2025

View reviewed changes

registry/coder/modules/claude-code/main.test.ts Outdated Show resolved Hide resolved

DevelopmentCats reviewed Aug 9, 2025

View reviewed changes

registry/coder-labs/modules/cursor-cli/main.test.ts Outdated Show resolved Hide resolved

DevelopmentCats reviewed Aug 9, 2025

View reviewed changes

registry/coder-labs/modules/cursor-cli/README.md Outdated Show resolved Hide resolved

matifali added 6 commits August 9, 2025 22:53

revert(claude-code): restore main.test.ts to origin/main state

414b5f2

refactor(cursor-cli): remove non-interactive flags from main.test.ts

f525189

refactor

fcd9f3a

fixup!

058cd8e

fixup!

8d3e5d6

wip

be5c394

DevelopmentCats reviewed Aug 12, 2025

View reviewed changes

registry/coder-labs/modules/cursor-cli/README.md Outdated Show resolved Hide resolved

Update registry/coder-labs/modules/cursor-cli/README.md

7391082

Co-authored-by: DevCats <christofer@coder.com>

feat: add support for agentapi

62a0a9c

35C4n0r dismissed DevelopmentCats’s stale review via 62a0a9c August 13, 2025 17:23

35C4n0r added 4 commits August 13, 2025 23:54

feat: add tests

2107f93

feat: update readme

1a38b7e

feat: update readme

d9e49f5

feat: update app slug

a8328f4

matifali commented Aug 14, 2025

View reviewed changes

35C4n0r added 4 commits August 14, 2025 11:59

feat: remove app and cli

3fdae36

feat: update readme

5da3721

feat: fix typo

3a4fc36

feat: update mcp_json to mcp

d1f518a

feat: update tests

2322298

35C4n0r marked this pull request as ready for review August 14, 2025 07:44

Merge branch 'main' into feat/cursor-cli-from-main

805b385

Copilot AI review requested due to automatic review settings August 14, 2025 13:45

Copilot AI reviewed Aug 14, 2025

View reviewed changes

35C4n0r and others added 5 commits August 14, 2025 19:27

Update registry/coder-labs/modules/cursor-cli/scripts/start.sh

10a96aa

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update registry/coder-labs/modules/cursor-cli/scripts/start.sh

f480d74

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update registry/coder-labs/modules/cursor-cli/testdata/cursor-cli-moc…

528b823

…k.sh Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

chore: update mock

c336e44

chore: remove comments

b99023b

	# Running mode is non-interactive by design for automation.
	# Module supports both interactive and non-interactive modes; interactive is the default.

	error_message = "Expected ai_prompt to be propagated via AI_PROMPT"
	condition = can(regex("ai_prompt='refactor the auth module to use JWT tokens'", resource.coder_script.cursor_cli.script))
	error_message = "Expected ai_prompt to be propagated via ai_prompt"

feat(cursor-cli): add Cursor CLI module #309

Are you sure you want to change the base?

feat(cursor-cli): add Cursor CLI module #309

Uh oh!

Conversation

matifali commented Aug 8, 2025

Summary

Test plan

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DevelopmentCats commented Aug 13, 2025

Uh oh!

35C4n0r commented Aug 13, 2025

Uh oh!

matifali commented Aug 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

35C4n0r commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

35C4n0r commented Aug 14, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

matifali commented Aug 14, 2025

Uh oh!

DevelopmentCats commented Aug 14, 2025

Uh oh!

35C4n0r commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

35C4n0r commented Aug 14, 2025

Uh oh!

Uh oh!

35C4n0r commented Aug 14, 2025 •

edited

Loading

35C4n0r commented Aug 14, 2025 •

edited

Loading