{"id":47706150,"url":"https://github.com/911218sky/mcp-cursor-message","last_synced_at":"2026-04-02T17:58:42.227Z","repository":{"id":347755317,"uuid":"1195178886","full_name":"911218sky/mcp-cursor-message","owner":"911218sky","description":"側欄 MCP 訊息佇列，銜接 Cursor / VS Code。 | Sidebar MCP message queue for Cursor \u0026 VS Code.","archived":false,"fork":false,"pushed_at":"2026-03-29T11:43:20.000Z","size":128,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-29T13:48:31.306Z","etag":null,"topics":["bun","cursor","mcp","model-context-protocol","typescript","vscode-extension"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/911218sky.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-03-29T10:36:49.000Z","updated_at":"2026-03-29T11:43:23.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/911218sky/mcp-cursor-message","commit_stats":null,"previous_names":["911218sky/mcp-cursor-message"],"tags_count":31,"template":false,"template_full_name":null,"purl":"pkg:github/911218sky/mcp-cursor-message","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/911218sky%2Fmcp-cursor-message","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/911218sky%2Fmcp-cursor-message/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/911218sky%2Fmcp-cursor-message/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/911218sky%2Fmcp-cursor-message/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/911218sky","download_url":"https://codeload.github.com/911218sky/mcp-cursor-message/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/911218sky%2Fmcp-cursor-message/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31312744,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bun","cursor","mcp","model-context-protocol","typescript","vscode-extension"],"created_at":"2026-04-02T17:58:41.556Z","updated_at":"2026-04-02T17:58:42.217Z","avatar_url":"https://github.com/911218sky.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mcp-cursor-message\n\n**MCP side-channel chat for Cursor and VS Code.** Queue messages from a sidebar, let your agent pull them with `check_messages`, run structured `ask_question` flows, and surface progress—without juggling copy-paste in the terminal.\n\n*Traditional Chinese:* [README.tw.md](./README.tw.md)\n\n[![License](https://img.shields.io/badge/license-AGPL--3.0-blue.svg)](./LICENSE)\n[![VS Code Engine](https://img.shields.io/badge/VS%20Code-%5E1.105.0-0098FF?logo=visualstudiocode\u0026logoColor=white)](https://code.visualstudio.com/)\n\n## Disclaimer\n\nThis project is provided **for academic exchange and technical research only**. The repository, extension, and MCP server are offered **as-is**, **without warranty of any kind**, whether express or implied. The authors and contributors **are not liable** for any damages arising from use or inability to use this software.\n\nYou are responsible for security and compliance. Output from this tool **does not constitute** professional advice. If you do not agree, do not download, install, or use this software.\n\n## What you get\n\nThe project pairs a **sidebar extension** with an **MCP server**: both share a small on-disk message store so the model and the UI stay in sync. Typical uses include queued user input, multi-step Q\u0026A with fixed options, and lightweight progress text shown next to the editor. The sidebar shows the queue, Q\u0026A cards, and reply summaries. **Language** is configurable from the panel header or **`mcpMessenger.uiLanguage`** (search **MCP chat** in Settings) for **zh**, **auto**, or **en**. With a folder workspace, the data directory is **`\u003cworkspace\u003e/.cursor/messenger-data`** and must match **`MESSENGER_DATA_DIR`** in your MCP config. If the workspace directory is empty, the extension will automatically migrate any existing **globalStorage** `messenger-data` into the workspace directory on first open.\n\n### For AI assistants (sidebar queue + MCP)\n\nHello, please strictly follow the conversation rules and use MCP to talk with me (`mcp-cursor-message`) every time. From now on, for all MCP-related questions, use MCP to interact with the user on every turn, and always invoke MCP after you send your reply.\n\n#### Suggested tool usage rules\n\nWhen using this MCP from an AI assistant or agent, we recommend the following default behavior:\n\n- **Use `send_progress` for multi-step work**:  \n  Whenever a task naturally breaks into two or more steps (for example: analyze → plan → implement → test), call `send_progress` after each key step with a short Markdown summary that includes:\n  - what you just finished,\n  - the current state and remaining work,\n  - what you plan to do next.\n- **Use `ask_question` instead of guessing**:  \n  When requirements are ambiguous or there are multiple reasonable strategies, prefer calling `ask_question` to present 2–4 concrete options (single or multi-select) and let the user choose, rather than silently picking one.\n\nThese rules complement the `SYSTEM_SUFFIX` instructions returned by `check_messages` in `mcp-server/index.ts`. If you override behavior in workspace rules, keep them consistent with these defaults.\n\n## Requirements\n\n- **Cursor** or **Visual Studio Code** (see `engines.vscode` in `package.json`)\n- **Bun** only if you build the `.vsix` from source\n\n## Quick start\n\n1. Install the latest **`.vsix`** from [**Releases**](https://github.com/911218sky/mcp-cursor-message/releases) via **Extensions → Install from VSIX…**, then reload the window.\n2. Open a **folder** workspace and run the command **mcp-cursor-message: Install MCP configuration** from the Command Palette so MCP points at the same data directory as the sidebar. Restart the editor if MCP does not appear.\n3. **Cursor:** Open **Cursor Settings → MCP** and **enable** the **mcp-cursor-message** server (or confirm it appears and is turned on). The sidebar works without this, but the agent **cannot** call `check_messages` until MCP is active for your workspace.\n\n## Commands (extension)\n\nOpen the **Command Palette** (*View → Command Palette*, or `Ctrl+Shift+P` on Windows/Linux, `Cmd+Shift+P` on macOS). Type `mcp-cursor-message` or part of the command title, then press Enter.\n\n| Command ID | Title | What it does |\n|------------|-------|----------------|\n| `mcpMessenger.setupMcp` | **mcp-cursor-message: Install MCP configuration** | Writes/merges `.cursor/mcp.json` in the workspace, registers the MCP server, and sets `MESSENGER_DATA_DIR` to match the sidebar data folder. Requires a **folder** workspace. |\n| `mcpMessenger.removeMcp` | **mcp-cursor-message: Remove MCP configuration** | Removes this extension’s MCP entry from `.cursor/mcp.json` (does not delete the whole file). |\n| `mcpMessenger.checkForUpdates` | **mcp-cursor-message: Check for updates (GitHub)** | Manually checks GitHub Releases for a newer VSIX (honors `mcpMessenger.updateCheck.*` settings). |\n\n*Traditional Chinese version of this section:* [README.tw.md](./README.tw.md)\n\n## MCP server tools\n\nThese are **not** Command Palette entries. The **AI agent** invokes them when **Cursor** (or another MCP client) has the **mcp-cursor-message** server enabled.\n\nEnable the server under **Cursor Settings → MCP**. The model calls tools by name from the agent tool list; parameters are defined in `mcp-server/index.ts` (`registerTool`).\n\n| Tool | Summary |\n|------|---------|\n| `check_messages` | Optional `reply` (Markdown) pushed to the sidebar. **Blocks** until the sidebar queue delivers a message or the wait times out. In typical flows this should be the **last** MCP call before ending a turn. |\n| `send_progress` | Required `progress` (Markdown). **Non-blocking**; updates the sidebar progress line. |\n| `ask_question` | Required `questions`. **Blocks** until the user answers in the sidebar (single/multi choice and optional free text). |\n\n*Traditional Chinese version:* [README.tw.md](./README.tw.md)\n\n## Settings\n\nAll keys live under the **`mcpMessenger`** prefix. In the editor: **Settings** → search **MCP chat**, or edit **User/Workspace `settings.json`** manually.\n\n| Setting | Type | Default | What it does |\n|---------|------|---------|----------------|\n| `mcpMessenger.uiLanguage` | `en` \\| `zh` \\| `auto` | `en` | Sidebar Webview language. **`auto`** follows the editor UI language (non-English → Chinese UI). |\n| `mcpMessenger.updateCheck.enabled` | boolean | `true` | When **`false`**, no update checks run (background or Command Palette), and no GitHub requests. |\n| `mcpMessenger.updateCheck.intervalHours` | number (≥ 1) | `12` | Hours between automatic update checks. |\n| `mcpMessenger.updateCheck.startupDelaySeconds` | number (≥ 0) | `15` | Seconds to wait after startup before the **first** check; **`0`** runs immediately. |\n| `mcpMessenger.updateCheck.repo` | string | `911218sky/mcp-cursor-message` | GitHub repo in **`owner/name`** form used for release checks. |\n| `mcpMessenger.updateCheck.versionCompare` | `patch` \\| `minor` \\| `major` \\| `off` | `minor` | **“Is newer”** always uses full **MAJOR.MINOR.PATCH** vs `releases/latest`. **`patch`** = background notify on any newer tag; **`minor`** (default) = only **minor** or **major** bumps (skip **patch-only**); **`major`** = **major** bumps only; **`off`** = no checks. **Manual** “Check for updates” **ignores** patch/minor/major filters (still blocked when `off` or `enabled: false`). Legacy values **`full`** and **`majorMinor`** map to **`patch`** and **`minor`**. |\n\n```json\n{\n  \"mcpMessenger.uiLanguage\": \"auto\",\n  \"mcpMessenger.updateCheck.enabled\": true,\n  \"mcpMessenger.updateCheck.versionCompare\": \"minor\",\n  \"mcpMessenger.updateCheck.repo\": \"911218sky/mcp-cursor-message\"\n}\n```\n\n*Traditional Chinese settings guide:* [README.tw.md](./README.tw.md)\n\n### Install from source\n\nClone the repository, install dependencies with **Bun**, build the extension package, then install the generated `.vsix` the same way as a release build:\n\n```bash\ngit clone https://github.com/911218sky/mcp-cursor-message.git\ncd mcp-cursor-message\nbun install\nbun run package\n```\n\nThe VSIX is written to the repository root (for example `mcp-cursor-message-9.2.0.vsix`, version from `package.json`).\n\n## Troubleshooting\n\n- **Webview fails to load** (including Service Worker–related messages): often a known class of issues in the embedded Chromium; try closing all windows and reopening, or update Cursor. See [microsoft/vscode#125993](https://github.com/microsoft/vscode/issues/125993).\n- **MCP does not appear** / tools never run: confirm you ran **mcp-cursor-message: Install MCP configuration** and restarted; in **Cursor Settings → MCP**, enable the server; check `.cursor/mcp.json` for the correct server command and `MESSENGER_DATA_DIR`.\n\n## Contributing \u0026 internals\n\nContributor workflow, IPC contracts, and versioning live in [**AGENTS.md**](./AGENTS.md) and [**PROJECT.md**](./PROJECT.md).\n\n## License\n\n[**AGPL-3.0**](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F911218sky%2Fmcp-cursor-message","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F911218sky%2Fmcp-cursor-message","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F911218sky%2Fmcp-cursor-message/lists"}