@apicircle/mcp-server 1.0.0 → 1.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.
Files changed (3) hide show
  1. package/LICENSE +2 -2
  2. package/README.md +24 -5
  3. package/package.json +4 -4
package/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- APICircle Studio License
1
+ API Circle Studio License
2
2
  Custom Source-Available License, v1.0
3
3
 
4
4
  Copyright (c) 2026 Deva Prakash ("Licensor")
@@ -65,7 +65,7 @@ Source Initiative.
65
65
  Software or any rights granted herein;
66
66
  (d) remove, obscure, or alter any copyright, trademark, attribution,
67
67
  or license notice contained in the Software;
68
- (e) use the names "APICircle", "API Circle Studio", or any related
68
+ (e) use the names "API Circle", "API Circle Studio", or any related
69
69
  logos or trademarks, except as required for accurate attribution.
70
70
 
71
71
  3. Contributions
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  <p align="center">
2
- <img src="https://raw.githubusercontent.com/apicircle/studio/main/assets/logo.png" alt="APICircle Studio" width="120" height="120" />
2
+ <img src="https://raw.githubusercontent.com/apicircle/studio/main/assets/logo.png" alt="API Circle Studio" width="120" height="120" />
3
3
  </p>
4
4
 
5
5
  <h1 align="center">@apicircle/mcp-server</h1>
6
6
 
7
- Model Context Protocol server for [APICircle Studio](https://github.com/apicircle/studio). Exposes the workspace as a 71-tool catalog any [MCP-compatible AI client](https://modelcontextprotocol.io) can drive — Claude Desktop, Claude Code, ChatGPT, GitHub Copilot, Cursor, Continue, Cline, Zed, Windsurf, and more.
7
+ Model Context Protocol server for [API Circle Studio](https://github.com/apicircle/studio). Exposes the workspace as a 71-tool catalog any [MCP-compatible AI client](https://modelcontextprotocol.io) can drive — Claude Desktop, Claude Code, ChatGPT, GitHub Copilot, Cursor, Continue, Cline, Zed, Windsurf, and more.
8
8
 
9
9
  ## Install
10
10
 
@@ -16,12 +16,31 @@ npm install -g @apicircle/mcp-server
16
16
  npm install @apicircle/mcp-server
17
17
  ```
18
18
 
19
+ ## What's a "workspace folder"?
20
+
21
+ `--workspace <dir>` points the server at a directory containing
22
+ `workspace.synced.json` + `workspace.local.json`. **That directory is a
23
+ git-cloned API Circle workspace repo** — created by the Desktop app's
24
+ _Link to Git_ feature, then cloned with `git clone`:
25
+
26
+ ```bash
27
+ git clone https://github.com/<you>/<your-workspace-repo>
28
+ apicircle-mcp --workspace ./<your-workspace-repo>
29
+ ```
30
+
31
+ **Don't have a workspace repo yet?** Use the **Desktop or Web app** instead.
32
+ Its workspace lives in browser storage (no folder needed), and the in-app
33
+ **MCP panel** generates a ready-to-paste config snippet for every supported
34
+ AI client — Claude Desktop, Cursor, Copilot, ChatGPT, and the rest — wired to
35
+ the app's workspace directly. This binary is the headless equivalent for
36
+ when you've outgrown the in-app flow.
37
+
19
38
  ## Run as a binary
20
39
 
21
40
  ```bash
22
- apicircle-mcp --workspace /path/to/your/workspace
41
+ apicircle-mcp --workspace /path/to/your/cloned/workspace/repo
23
42
  # or
24
- APICIRCLE_WORKSPACE=/path/to/workspace apicircle-mcp
43
+ APICIRCLE_WORKSPACE=/path/to/cloned/workspace/repo apicircle-mcp
25
44
  ```
26
45
 
27
46
  The server reads JSON-RPC on stdin and writes responses on stdout. Logs go to stderr. Wire it into your AI client per [Connect your AI client](https://github.com/apicircle/studio/blob/main/docs/connect-your-ai-client.md).
@@ -65,4 +84,4 @@ The Electron desktop app supplies its own IPC-backed providers so renderer-side
65
84
 
66
85
  ## License
67
86
 
68
- Released under the **APICircle Studio License** — a custom source-available license, not an OSI-approved open-source license. Free for personal, educational, and non-commercial use, plus a 30-day commercial evaluation period; ongoing commercial use requires a separate license. See [LICENSE](./LICENSE) for the full terms, or contact **apicircle365@gmail.com** for commercial licensing.
87
+ Released under the **API Circle Studio License** — a custom source-available license, not an OSI-approved open-source license. Free for personal, educational, and non-commercial use, plus a 30-day commercial evaluation period; ongoing commercial use requires a separate license. See [LICENSE](./LICENSE) for the full terms, or contact **apicircle365@gmail.com** for commercial licensing.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@apicircle/mcp-server",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "Model Context Protocol server exposing API Circle Studio's workspace as a tool catalog. Used by Claude Desktop, ChatGPT, Cursor, GitHub Copilot, and any other MCP-compatible AI client.",
@@ -38,9 +38,9 @@
38
38
  "dependencies": {
39
39
  "@modelcontextprotocol/sdk": "^1.0.0",
40
40
  "zod": "^3.23.0",
41
- "@apicircle/core": "1.0.0",
42
- "@apicircle/mock-server-core": "1.0.0",
43
- "@apicircle/shared": "1.0.0"
41
+ "@apicircle/mock-server-core": "1.0.1",
42
+ "@apicircle/shared": "1.0.1",
43
+ "@apicircle/core": "1.0.1"
44
44
  },
45
45
  "devDependencies": {
46
46
  "@types/node": "^20.0.0",