@speakai/mcp-server 1.43.3 → 2.0.1

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.
package/README.md CHANGED
@@ -39,11 +39,9 @@ The AI does the searching, summarizing, and citing. Your recordings stay in your
39
39
 
40
40
  ## Install (pick your tool)
41
41
 
42
- > **Two paths to install**: pick whichever feels easier. The one-click connect path approves access via a permission popup; the manual path pastes an API key into a header.
42
+ > **Start with the hosted connector.** Every assistant below connects to `https://api.speakai.co/v1/mcp` and signs you in through your browser on Speak AI's own page, where you can sign in or create a free account. There is no API key to copy. An API key setup is still available for local file upload, scripts and machines with no browser; see [Developer reference](#developer-reference-cli-api-advanced-setup).
43
43
 
44
- > **Don't know which one to pick?** Install it in the AI assistant you already use. Every option below connects to the same Speak AI workspace.
45
-
46
- > Speak AI's connector address (paste this into your AI tool's connector settings; it's the same idea as pasting a Zoom link into your calendar): `https://api.speakai.co/v1/mcp`
44
+ > **Don't know which one to pick?** Install it in the AI assistant you already use. Every option below connects to the same Speak AI account.
47
45
 
48
46
  ### Claude.ai (web)
49
47
 
@@ -128,32 +126,61 @@ Still stuck? Email [success@speakai.co](mailto:success@speakai.co).
128
126
 
129
127
  ### Claude Code (terminal)
130
128
 
131
- **Recommended: install from the official Claude Code plugin marketplace:**
129
+ Add the hosted connector, then sign in:
130
+
131
+ ```sh
132
+ claude mcp add --transport http speakai https://api.speakai.co/v1/mcp
133
+ claude mcp login speakai
134
+ ```
135
+
136
+ `claude mcp login` opens Speak AI's sign-in page in your browser. Sign in or create an account, then click **Allow**. You can also type `/mcp` inside Claude Code, pick **speakai** and choose to authenticate. On a machine with no browser (for example over SSH), run `claude mcp login speakai --no-browser`, open the printed link on another device, and paste the address your browser ends on back into the terminal.
137
+
138
+ Add `--scope user` to the first command to use Speak AI in every project instead of only the current one.
139
+
140
+ **Or install the plugin**, which adds the same hosted connector plus Speak AI skills:
132
141
 
133
142
  1. Add the official marketplace (one-time): `/plugin marketplace add claude-plugins-official`
134
143
  2. Install the plugin: `/plugin install speakai@claude-plugins-official`
135
144
  3. Activate it: `/reload-plugins`
136
- 4. Run the `getting-started` skill and paste your Speak AI API key. Generate one at [app.speakai.co/developers/apikeys](https://app.speakai.co/developers/apikeys).
145
+ 4. Type `/mcp`, pick **speakai** and sign in to Speak AI in your browser.
137
146
 
138
147
  If `/plugin install` doesn't find Speak AI, refresh the local catalog with `/plugin marketplace update claude-plugins-official` and retry.
139
148
 
140
149
  <details>
141
- <summary>Developer alternative: manual HTTP transport</summary>
150
+ <summary>Alternative: send an API key instead of signing in</summary>
151
+
152
+ ```sh
153
+ claude mcp add --transport http speakai https://api.speakai.co/v1/mcp \
154
+ --header "Authorization: Bearer $SPEAKAI_KEY"
155
+ ```
156
+
157
+ Set `SPEAKAI_KEY` in your shell first. Generate a key at [app.speakai.co/developers/apikeys](https://app.speakai.co/developers/apikeys).
142
158
 
143
- Skip the plugin and add the connector directly:
159
+ </details>
160
+
161
+ ### Codex (terminal)
144
162
 
145
163
  ```sh
146
- claude mcp add speakai --transport http --url https://api.speakai.co/v1/mcp
164
+ codex mcp add speakai --url https://api.speakai.co/v1/mcp
147
165
  ```
148
166
 
149
- Claude Code will open an OAuth window for sign-in. To bypass OAuth and pass a Bearer token instead:
167
+ Codex detects that Speak AI uses browser sign-in and opens Speak AI's sign-in page right away. Sign in or create an account, then click **Allow**. If the browser did not open, or you closed it before finishing, run:
150
168
 
151
169
  ```sh
152
- claude mcp add speakai --transport http --url https://api.speakai.co/v1/mcp \
153
- --header "Authorization: Bearer $SPEAKAI_KEY"
170
+ codex mcp login speakai
154
171
  ```
155
172
 
156
- Set `SPEAKAI_KEY` in your shell first, or paste your key inline. Generate a key at [app.speakai.co/developers/apikeys](https://app.speakai.co/developers/apikeys).
173
+ Check the connection with `codex mcp list`; Speak AI shows **OAuth** in the Auth column.
174
+
175
+ <details>
176
+ <summary>Alternative: send an API key instead of signing in</summary>
177
+
178
+ ```sh
179
+ export SPEAKAI_KEY="your-api-key"
180
+ codex mcp add speakai --url https://api.speakai.co/v1/mcp --bearer-token-env-var SPEAKAI_KEY
181
+ ```
182
+
183
+ Generate a key at [app.speakai.co/developers/apikeys](https://app.speakai.co/developers/apikeys).
157
184
 
158
185
  </details>
159
186
 
@@ -161,10 +188,22 @@ Set `SPEAKAI_KEY` in your shell first, or paste your key inline. Generate a key
161
188
 
162
189
  [![Add to Cursor](https://img.shields.io/badge/Cursor-Install_Speak_AI-000000?logo=cursor&logoColor=white&style=for-the-badge)](cursor://anysphere.cursor-deeplink/mcp/install?name=speakai&config=eyJ1cmwiOiJodHRwczovL2FwaS5zcGVha2FpLmNvL3YxL21jcCJ9)
163
190
 
164
- Click the button. Cursor registers itself automatically and opens the permission popup. Sign in to Speak AI and click **Allow**.
191
+ Click the button, or add this to `~/.cursor/mcp.json` (every project) or `.cursor/mcp.json` (one project):
192
+
193
+ ```json
194
+ {
195
+ "mcpServers": {
196
+ "speakai": {
197
+ "url": "https://api.speakai.co/v1/mcp"
198
+ }
199
+ }
200
+ }
201
+ ```
202
+
203
+ Then open **Cursor Settings → Tools & MCP**. Speak AI shows that it needs a login; click it to open Speak AI's sign-in page in your browser, sign in or create an account, and click **Allow**.
165
204
 
166
205
  <details>
167
- <summary>Developer alternative: manual setup with an API key</summary>
206
+ <summary>Alternative: local setup with an API key</summary>
168
207
 
169
208
  Use the manual stdio setup in the Developer reference at the bottom of this README.
170
209
 
@@ -275,11 +314,11 @@ Get a Speak AI API key at [app.speakai.co/developers/apikeys](https://app.speaka
275
314
 
276
315
  ### CLI / npm package
277
316
 
278
- The `@speakai/mcp-server` npm package provides:
317
+ The `@speakai/mcp-server` npm package runs on your own machine with a Speak AI API key. Use it when you need to upload local files from your computer, run scripts and pipelines, or connect a client that can't open a browser or doesn't support remote HTTP servers. It provides:
279
318
 
280
319
  - A CLI (`speakai-mcp`) for scripting and pipelines.
281
320
  - A stdio-mode MCP server for clients that don't support remote HTTP transport.
282
- - An auto-setup wizard that detects installed MCP clients and configures them.
321
+ - A setup wizard that shows the hosted connector command for the assistants it finds (Claude Code, Codex, Cursor), then offers to set up an API key for the local server and CLI.
283
322
 
284
323
  ```sh
285
324
  npm install -g @speakai/mcp-server
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
1
+ import type { McpServer } from "@modelcontextprotocol/server";
2
2
  import { AxiosInstance } from "axios";
3
3
 
4
4
  export interface RegisterOptions {