Skip to content

docs: document Cursor MCP setup - #317

Open
monsterlag wants to merge 1 commit into
cocoindex-io:mainfrom
monsterlag:fix/issue-292-c572
Open

monsterlag wants to merge 1 commit into
cocoindex-io:mainfrom
monsterlag:fix/issue-292-c572

Conversation

@monsterlag

Copy link
Copy Markdown

Note

AI-generated, not reviewed by a human. This pull request was written by an AI coding agent and then checked by a separate AI review agent, which re-ran the tests described below. No human has reviewed the code. It is submitted by @monsterlag, who runs these agents. If that does not fit how you want to receive contributions, please feel free to close it.

Summary

The README advertises Cursor integration but does not show how to configure its MCP client, leaving a setup gap reported in #292.

Add a Cursor example alongside the existing MCP client instructions:

  • Initialize the project with ccc init before connecting.
  • Configure .cursor/mcp.json to run the existing ccc mcp stdio server.
  • Set COCOINDEX_CODE_HOST_CWD using ${workspaceFolder} so project discovery does not depend on Cursor's launch directory.
  • Explain executable-path troubleshooting and link to Cursor's official MCP docs.

Documentation only; no runtime or breaking changes. Related to #292.

Testing

  • A local README/JSON validation check failed before the change and passed afterward.
  • A real MCP stdio smoke test using the example's command and environment successfully initialized a session, listed the search tool, and indexed/searched a temporary project from an unrelated launch directory. Workspace interpolation was performed by the test client, not Cursor.
  • uv run pytest tests/test_cli_helpers.py tests/test_server.py — 39 passed.
  • COCOINDEX_DISABLE_USAGE_TRACKING=1 uv run pytest tests/ -v — 350 passed, 8 Docker tests deselected by the default configuration.
  • uv run ruff check . and uv run ruff format --check . — passed.
  • uv run mypy src/ tests/ — passed.
  • COCOINDEX_DISABLE_USAGE_TRACKING=1 uv run prek run --all-files — all hooks passed.
  • git diff --check — passed.

The broader uv run mypy . also checked the unchanged scripts/find_best_models.py and reported missing tabulate stubs and an optional-datetime strftime error. The project's CI-scoped typecheck above passes. No end-to-end Cursor UI validation was performed.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant