@caffeineai/mcp 0.1.0-dev.24 → 0.1.0-dev.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +69 -123
  2. package/package.json +10 -10
package/README.md CHANGED
@@ -1,79 +1,44 @@
1
1
  # @caffeineai/mcp
2
2
 
3
- MCP server that gives AI coding tools access to Caffeine projects.
3
+ An MCP server that exposes Caffeine auth, project, build, config, and chat
4
+ operations to AI coding hosts.
4
5
 
5
6
  ## Development Release
6
7
 
7
- This is a DEV release. It is published under the npm `dev` dist-tag and is subject to a rapid release cadence. Expect frequent updates while the CLI and MCP packages settle.
8
+ This is a DEV release. It is published under the npm `dev` dist-tag and is
9
+ subject to a rapid release cadence. Expect frequent updates while the MCP
10
+ package settles.
8
11
 
9
- Once installed and authenticated, your agent can list, clone, build, check, and preview Caffeine projects from inside your editor.
10
-
11
- ## Prerequisites
12
-
13
- Node.js 20 or later.
14
-
15
- ```bash
16
- node --version
17
- ```
18
-
19
- The MCP server includes its own auth tools. You do not need to install or log in with the CLI first.
20
-
21
- ## Pre-Warm The Package Cache
22
-
23
- The published package contains a native binary. `npx -y` caches it after the first download, but the first invocation often happens inside an MCP host process with a startup timeout. On a slow connection the host can mark the server as offline before the download finishes.
24
-
25
- Run this once in a terminal before relying on the server from any host:
12
+ ## Quick Start
26
13
 
27
14
  ```bash
28
15
  npx -y @caffeineai/mcp@dev --version
29
16
  ```
30
17
 
31
- After that, hosts on the same machine start the server from cache. Subsequent runs only re-download when a newer dev version has been published.
18
+ The first run pre-warms the package cache. That matters because MCP hosts often
19
+ apply startup timeouts, and a cold binary download can make the server look
20
+ offline even though the install is still in progress.
32
21
 
33
- ## Check The Installed Version
34
-
35
- For minimal output:
36
-
37
- ```bash
38
- npx -y @caffeineai/mcp@dev --version
39
- ```
40
-
41
- For the standard JSON envelope:
42
-
43
- ```bash
44
- npx -y @caffeineai/mcp@dev --version --json
45
- ```
22
+ The server includes its own auth tools. You do not need to install the CLI
23
+ first.
46
24
 
47
25
  ## Install Into Your Host
48
26
 
49
- All snippets below use the stdio transport with `npx -y @caffeineai/mcp@dev` as the command.
50
-
51
27
  ### Claude Code
52
28
 
53
- User-wide:
54
-
55
29
  ```bash
56
30
  claude mcp add --transport stdio --scope user caffeine -- npx -y @caffeineai/mcp@dev
57
31
  ```
58
32
 
59
- Project-wide, in `.mcp.json`:
33
+ ### OpenAI Codex
60
34
 
61
- ```json
62
- {
63
- "mcpServers": {
64
- "caffeine": {
65
- "command": "npx",
66
- "args": ["-y", "@caffeineai/mcp@dev"]
67
- }
68
- }
69
- }
35
+ ```bash
36
+ codex mcp add caffeine -- npx -y @caffeineai/mcp@dev
70
37
  ```
71
38
 
72
- Inside Claude Code, type `/mcp` to see server status.
73
-
74
39
  ### Cursor
75
40
 
76
- `.cursor/mcp.json` for a project, or `~/.cursor/mcp.json` globally:
41
+ Add this to `.cursor/mcp.json` or `~/.cursor/mcp.json`:
77
42
 
78
43
  ```json
79
44
  {
@@ -87,49 +52,15 @@ Inside Claude Code, type `/mcp` to see server status.
87
52
  }
88
53
  ```
89
54
 
90
- Restart Cursor after adding the config.
91
-
92
55
  ### VS Code With GitHub Copilot
93
56
 
94
57
  ```bash
95
58
  code --add-mcp '{"name":"caffeine","command":"npx","args":["-y","@caffeineai/mcp@dev"]}'
96
59
  ```
97
60
 
98
- Or `.vscode/mcp.json`:
99
-
100
- ```json
101
- {
102
- "servers": {
103
- "caffeine": {
104
- "type": "stdio",
105
- "command": "npx",
106
- "args": ["-y", "@caffeineai/mcp@dev"]
107
- }
108
- }
109
- }
110
- ```
111
-
112
- Verify via the command palette: `MCP: List Servers`.
113
-
114
- ### OpenAI Codex
115
-
116
- ```bash
117
- codex mcp add caffeine -- npx -y @caffeineai/mcp@dev
118
- ```
119
-
120
- Or `~/.codex/config.toml`:
121
-
122
- ```toml
123
- [mcp_servers.caffeine]
124
- command = "npx"
125
- args = ["-y", "@caffeineai/mcp@dev"]
126
- ```
127
-
128
- Verify with `codex mcp list`.
129
-
130
61
  ### Windsurf
131
62
 
132
- `~/.codeium/windsurf/mcp_config.json`:
63
+ Add this to `~/.codeium/windsurf/mcp_config.json`:
133
64
 
134
65
  ```json
135
66
  {
@@ -142,29 +73,55 @@ Verify with `codex mcp list`.
142
73
  }
143
74
  ```
144
75
 
145
- Quit and reopen Windsurf after adding the config.
146
-
147
76
  ## Available Tools
148
77
 
149
- | Tool | Description |
150
- | --- | --- |
151
- | `caffeine_auth_login` | Start a login flow. Returns an auth URL by default, or a device code when called with `deviceFlow: true` |
152
- | `caffeine_auth_logout` | Log out and clear local credentials |
153
- | `caffeine_auth_status` | Check authentication status |
154
- | `caffeine_list_projects` | List your projects |
155
- | `caffeine_show_project` | Get project details |
156
- | `caffeine_create_project` | Create a project |
157
- | `caffeine_delete_project` | Delete a project |
158
- | `caffeine_clone_project` | Clone a project locally |
159
- | `caffeine_import_project` | Import a project from a .zip |
160
- | `caffeine_export_project` | Export the current project to a .zip |
161
- | `caffeine_build` | Build the project |
162
- | `caffeine_check` | Validate code and configuration |
163
- | `caffeine_preview` | Upload a built project as a draft |
164
- | `caffeine_doctor` | Diagnose the local toolchain |
165
- | `caffeine_config_list` / `caffeine_config_get` / `caffeine_config_set` | Manage CLI config |
166
-
167
- All tools return the same stable `{ ok, data }` / `{ ok, error }` envelope used by the CLI's `--json` mode.
78
+ | Group | Tool | Description |
79
+ | --- | --- | --- |
80
+ | Auth | `caffeine_auth_login` | Start a browser or device login flow |
81
+ | Auth | `caffeine_auth_logout` | Log out and clear local credentials |
82
+ | Auth | `caffeine_auth_status` | Check authentication status |
83
+ | Projects | `caffeine_list_projects` | List projects |
84
+ | Projects | `caffeine_show_project` | Get project details |
85
+ | Projects | `caffeine_create_project` | Create a project |
86
+ | Projects | `caffeine_delete_project` | Delete a project |
87
+ | Projects | `caffeine_clone_project` | Clone a project locally |
88
+ | Local | `caffeine_import_project` | Import a project from a `.zip` |
89
+ | Local | `caffeine_export_project` | Export the current project to a `.zip` |
90
+ | Build | `caffeine_build` | Build the project |
91
+ | Build | `caffeine_check` | Validate code and configuration |
92
+ | Build | `caffeine_preview` | Upload a built project as a draft |
93
+ | Config | `caffeine_config_list` / `caffeine_config_get` / `caffeine_config_set` | Manage CLI config |
94
+ | Env | `caffeine_doctor` | Diagnose local toolchain health |
95
+ | Chat | `caffeine_chat_start_session` | Start a chat session |
96
+ | Chat | `caffeine_chat_active_sessions` | Discover likely active chat sessions |
97
+ | Chat | `caffeine_chat_resume_session` | Reattach and wait for the next stable state |
98
+ | Chat | `caffeine_chat_watch_session` | Stream live session updates |
99
+ | Chat | `caffeine_chat_session_status` | Summarize an active session |
100
+ | Chat | `caffeine_chat_session_transcript` | Show the current transcript |
101
+ | Chat | `caffeine_chat_session_feed` | Collect raw feed events |
102
+ | Chat | `caffeine_chat_detach_session` | Mark a client-side session as detached |
103
+ | Chat | `caffeine_chat_send` | Send a prompt |
104
+ | Chat | `caffeine_chat_reply` | Send a freeform clarification reply |
105
+ | Chat | `caffeine_chat_list` | List chat messages |
106
+ | Chat | `caffeine_chat_tail` | Poll messages until the AI reaches a stable state |
107
+ | Chat | `caffeine_chat_submit_form` | Submit a structured clarification form reply |
108
+ | Chat | `caffeine_chat_url` | Return the browser chat URL |
109
+
110
+ These tools sit on top of `@caffeine/sdk`, so they use the same underlying
111
+ chat contract as the CLI.
112
+
113
+ ## Example Operations
114
+
115
+ - Log in from your MCP host, then inspect or clone projects
116
+ - Build, check, preview, import, export, or diagnose a local project from the same host
117
+ - Start an interactive chat session and watch it live
118
+ - Detach and later resume or inspect likely active sessions
119
+ - Read the high-level session status, transcript, or raw feed events
120
+ - Submit a structured clarification form from a `system_dialog` message
121
+ - Hand off to the browser chat when needed
122
+
123
+ All tools return the same stable `{ ok, data }` / `{ ok, error }` envelope
124
+ used by the CLI's `--json` mode.
168
125
 
169
126
  ## Supported Platforms
170
127
 
@@ -176,22 +133,11 @@ Native binaries ship for:
176
133
 
177
134
  ## Troubleshooting
178
135
 
179
- - **Server shows as offline on first use.** Run `npx -y @caffeineai/mcp@dev --version` in a terminal, then restart your host.
180
- - **Not logged in errors.** Ask your MCP host to call `caffeine_auth_login`, complete the browser or device-code flow, then call `caffeine_auth_status`.
181
- - **Config changes not taking effect.** Most hosts do not hot-reload MCP configs. Restart the host after editing MCP config files.
182
- - **`command not found: npx`.** Install Node.js 20+ and ensure `npx` is on your `PATH`.
183
-
184
- ## Quick Transport Check
185
-
186
- With no host running, you can pipe a JSON-RPC request directly:
187
-
188
- ```bash
189
- echo '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}' | npx -y @caffeineai/mcp@dev
190
- ```
191
-
192
- ## Links
193
-
194
- - Caffeine platform: https://caffeine.ai
195
- - Model Context Protocol: https://modelcontextprotocol.io
136
+ - If the server appears offline on first use, run `npx -y @caffeineai/mcp@dev --version` in a terminal, then restart the host.
137
+ - If you see auth errors, call `caffeine_auth_login`, complete the flow, then call `caffeine_auth_status`.
138
+ - `caffeine_chat_watch_session` and `caffeine_chat_resume_session` are the
139
+ main live-session tools for interactive hosts.
140
+ - `caffeine_chat_feed` exposes raw project feed events when a host wants lower
141
+ level progress data.
196
142
 
197
143
  This package installs the matching platform binary through npm optional dependencies. Install the main package rather than a platform package directly.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caffeineai/mcp",
3
- "version": "0.1.0-dev.24",
3
+ "version": "0.1.0-dev.26",
4
4
  "description": "Caffeine MCP server",
5
5
  "homepage": "https://caffeine.ai",
6
6
  "license": "SEE LICENSE IN LICENSE",
@@ -13,14 +13,14 @@
13
13
  "LICENSE"
14
14
  ],
15
15
  "optionalDependencies": {
16
- "@caffeineai/mcp-darwin-arm64": "0.1.0-dev.24",
17
- "@caffeineai/mcp-darwin-x64": "0.1.0-dev.24",
18
- "@caffeineai/mcp-linux-arm64-glibc": "0.1.0-dev.24",
19
- "@caffeineai/mcp-linux-x64-glibc": "0.1.0-dev.24",
20
- "@caffeineai/mcp-linux-arm64-musl": "0.1.0-dev.24",
21
- "@caffeineai/mcp-linux-x64-musl": "0.1.0-dev.24",
22
- "@caffeineai/mcp-win32-arm64": "0.1.0-dev.24",
23
- "@caffeineai/mcp-win32-x64": "0.1.0-dev.24"
16
+ "@caffeineai/mcp-darwin-arm64": "0.1.0-dev.26",
17
+ "@caffeineai/mcp-darwin-x64": "0.1.0-dev.26",
18
+ "@caffeineai/mcp-linux-arm64-glibc": "0.1.0-dev.26",
19
+ "@caffeineai/mcp-linux-x64-glibc": "0.1.0-dev.26",
20
+ "@caffeineai/mcp-linux-arm64-musl": "0.1.0-dev.26",
21
+ "@caffeineai/mcp-linux-x64-musl": "0.1.0-dev.26",
22
+ "@caffeineai/mcp-win32-arm64": "0.1.0-dev.26",
23
+ "@caffeineai/mcp-win32-x64": "0.1.0-dev.26"
24
24
  },
25
25
  "preferGlobal": true,
26
26
  "publishConfig": {
@@ -29,6 +29,6 @@
29
29
  "caffeine": {
30
30
  "distribution": "npmjs",
31
31
  "packageName": "@caffeineai/mcp",
32
- "publishedAt": "2026-05-12T14:56:44.815Z"
32
+ "publishedAt": "2026-05-12T20:50:59.167Z"
33
33
  }
34
34
  }