@manhq/localmcp 1.0.0 → 1.0.2

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 (80) hide show
  1. package/README.md +177 -66
  2. package/README.vi.md +176 -65
  3. package/dist/api/openapi.d.ts +21 -0
  4. package/dist/api/openapi.d.ts.map +1 -0
  5. package/dist/api/openapi.js +74 -0
  6. package/dist/api/openapi.js.map +1 -0
  7. package/dist/api/playground.d.ts +2 -0
  8. package/dist/api/playground.d.ts.map +1 -0
  9. package/dist/api/playground.js +24 -0
  10. package/dist/api/playground.js.map +1 -0
  11. package/dist/api/registry.d.ts +19 -0
  12. package/dist/api/registry.d.ts.map +1 -0
  13. package/dist/api/registry.js +20 -0
  14. package/dist/api/registry.js.map +1 -0
  15. package/dist/api/rest.d.ts +3 -0
  16. package/dist/api/rest.d.ts.map +1 -0
  17. package/dist/api/rest.js +84 -0
  18. package/dist/api/rest.js.map +1 -0
  19. package/dist/api/server-with-registry.d.ts +8 -0
  20. package/dist/api/server-with-registry.d.ts.map +1 -0
  21. package/dist/api/server-with-registry.js +43 -0
  22. package/dist/api/server-with-registry.js.map +1 -0
  23. package/dist/cli.d.ts.map +1 -1
  24. package/dist/cli.js +82 -19
  25. package/dist/cli.js.map +1 -1
  26. package/dist/index.d.ts +2 -0
  27. package/dist/index.d.ts.map +1 -1
  28. package/dist/index.js +125 -48
  29. package/dist/index.js.map +1 -1
  30. package/dist/services/atlassian/index.d.ts +1 -1
  31. package/dist/services/atlassian/index.d.ts.map +1 -1
  32. package/dist/services/atlassian/index.js +3 -3
  33. package/dist/services/atlassian/index.js.map +1 -1
  34. package/dist/services/atlassian/tools/confluence.d.ts +1 -1
  35. package/dist/services/atlassian/tools/confluence.d.ts.map +1 -1
  36. package/dist/services/atlassian/tools/confluence.js +14 -13
  37. package/dist/services/atlassian/tools/confluence.js.map +1 -1
  38. package/dist/services/atlassian/tools/jira.d.ts +1 -1
  39. package/dist/services/atlassian/tools/jira.d.ts.map +1 -1
  40. package/dist/services/atlassian/tools/jira.js +16 -15
  41. package/dist/services/atlassian/tools/jira.js.map +1 -1
  42. package/dist/services/figma/index.d.ts +1 -1
  43. package/dist/services/figma/index.d.ts.map +1 -1
  44. package/dist/services/figma/index.js +6 -6
  45. package/dist/services/figma/index.js.map +1 -1
  46. package/dist/services/figma/tools/comments.d.ts +1 -1
  47. package/dist/services/figma/tools/comments.d.ts.map +1 -1
  48. package/dist/services/figma/tools/comments.js +4 -3
  49. package/dist/services/figma/tools/comments.js.map +1 -1
  50. package/dist/services/figma/tools/components.d.ts +1 -1
  51. package/dist/services/figma/tools/components.d.ts.map +1 -1
  52. package/dist/services/figma/tools/components.js +7 -6
  53. package/dist/services/figma/tools/components.js.map +1 -1
  54. package/dist/services/figma/tools/files.d.ts +1 -1
  55. package/dist/services/figma/tools/files.d.ts.map +1 -1
  56. package/dist/services/figma/tools/files.js +4 -3
  57. package/dist/services/figma/tools/files.js.map +1 -1
  58. package/dist/services/figma/tools/images.d.ts +1 -1
  59. package/dist/services/figma/tools/images.d.ts.map +1 -1
  60. package/dist/services/figma/tools/images.js +4 -3
  61. package/dist/services/figma/tools/images.js.map +1 -1
  62. package/dist/services/figma/tools/variables.d.ts +1 -1
  63. package/dist/services/figma/tools/variables.d.ts.map +1 -1
  64. package/dist/services/figma/tools/variables.js +4 -3
  65. package/dist/services/figma/tools/variables.js.map +1 -1
  66. package/dist/services/google-chat/index.d.ts +1 -1
  67. package/dist/services/google-chat/index.d.ts.map +1 -1
  68. package/dist/services/google-chat/index.js +2 -2
  69. package/dist/services/google-chat/index.js.map +1 -1
  70. package/dist/services/google-chat/tools/messages.d.ts +1 -1
  71. package/dist/services/google-chat/tools/messages.d.ts.map +1 -1
  72. package/dist/services/google-chat/tools/messages.js +6 -5
  73. package/dist/services/google-chat/tools/messages.js.map +1 -1
  74. package/docs/atlassian.md +145 -6
  75. package/docs/figma.md +145 -6
  76. package/docs/google-chat.md +145 -6
  77. package/docs/vi/atlassian.md +145 -6
  78. package/docs/vi/figma.md +145 -6
  79. package/docs/vi/google-chat.md +145 -6
  80. package/package.json +5 -3
package/docs/atlassian.md CHANGED
@@ -33,34 +33,82 @@ http://localhost:47001/mcp/atlassian
33
33
 
34
34
  ## Register with AI Agents
35
35
 
36
- **Claude Code**`.claude/settings.local.json`
36
+ Each agent supports two transports pick whichever fits your setup:
37
+
38
+ - **HTTP** — requires the server to be running (`localmcp`). Shared across agents.
39
+ - **stdio** — the agent spawns the process on demand. No running server needed.
40
+
41
+ Or use `localmcp register` to set up automatically.
42
+
43
+ ---
44
+
45
+ ### Claude Code
46
+
47
+ **HTTP** — `.claude/settings.local.json`
37
48
  ```json
38
49
  {
39
50
  "mcpServers": {
40
51
  "atlassian": {
52
+ "type": "http",
41
53
  "url": "http://localhost:47001/mcp/atlassian"
42
54
  }
43
55
  }
44
56
  }
45
57
  ```
46
58
 
59
+ **stdio** — `.claude/settings.local.json`
60
+ ```json
61
+ {
62
+ "mcpServers": {
63
+ "atlassian": {
64
+ "type": "stdio",
65
+ "command": "localmcp",
66
+ "args": ["stdio", "atlassian"]
67
+ }
68
+ }
69
+ }
70
+ ```
71
+
47
72
  Or register from the command line:
48
73
  ```bash
74
+ # HTTP
49
75
  claude mcp add --transport http atlassian http://localhost:47001/mcp/atlassian
76
+
77
+ # stdio
78
+ claude mcp add atlassian localmcp stdio atlassian
50
79
  ```
51
80
 
52
- **Codex** — `~/.codex/config.toml`
81
+ ---
82
+
83
+ ### Codex
84
+
85
+ **HTTP** — `~/.codex/config.toml`
53
86
  ```toml
54
87
  [mcp_servers.atlassian]
55
88
  url = "http://localhost:47001/mcp/atlassian"
56
89
  ```
57
90
 
91
+ **stdio** — `~/.codex/config.toml`
92
+ ```toml
93
+ [mcp_servers.atlassian]
94
+ command = "localmcp"
95
+ args = ["stdio", "atlassian"]
96
+ ```
97
+
58
98
  Or register from the command line:
59
99
  ```bash
100
+ # HTTP
60
101
  codex mcp add atlassian --url http://localhost:47001/mcp/atlassian
102
+
103
+ # stdio
104
+ codex mcp add atlassian localmcp stdio atlassian
61
105
  ```
62
106
 
63
- **GitHub Copilot / VS Code** — `.vscode/mcp.json`
107
+ ---
108
+
109
+ ### GitHub Copilot / VS Code
110
+
111
+ **HTTP** — `.vscode/mcp.json`
64
112
  ```json
65
113
  {
66
114
  "servers": {
@@ -72,7 +120,24 @@ codex mcp add atlassian --url http://localhost:47001/mcp/atlassian
72
120
  }
73
121
  ```
74
122
 
75
- **Cursor** — `.cursor/mcp.json`
123
+ **stdio** — `.vscode/mcp.json`
124
+ ```json
125
+ {
126
+ "servers": {
127
+ "atlassian": {
128
+ "type": "stdio",
129
+ "command": "localmcp",
130
+ "args": ["stdio", "atlassian"]
131
+ }
132
+ }
133
+ }
134
+ ```
135
+
136
+ ---
137
+
138
+ ### Cursor
139
+
140
+ **HTTP** — `.cursor/mcp.json`
76
141
  ```json
77
142
  {
78
143
  "mcpServers": {
@@ -83,7 +148,23 @@ codex mcp add atlassian --url http://localhost:47001/mcp/atlassian
83
148
  }
84
149
  ```
85
150
 
86
- **Windsurf** — `~/.codeium/windsurf/mcp_config.json`
151
+ **stdio** — `.cursor/mcp.json`
152
+ ```json
153
+ {
154
+ "mcpServers": {
155
+ "atlassian": {
156
+ "command": "localmcp",
157
+ "args": ["stdio", "atlassian"]
158
+ }
159
+ }
160
+ }
161
+ ```
162
+
163
+ ---
164
+
165
+ ### Windsurf
166
+
167
+ **HTTP** — `~/.codeium/windsurf/mcp_config.json`
87
168
  ```json
88
169
  {
89
170
  "mcpServers": {
@@ -94,7 +175,23 @@ codex mcp add atlassian --url http://localhost:47001/mcp/atlassian
94
175
  }
95
176
  ```
96
177
 
97
- **Antigravity** — `~/.gemini/config/mcp_config.json`
178
+ **stdio** — `~/.codeium/windsurf/mcp_config.json`
179
+ ```json
180
+ {
181
+ "mcpServers": {
182
+ "atlassian": {
183
+ "command": "localmcp",
184
+ "args": ["stdio", "atlassian"]
185
+ }
186
+ }
187
+ }
188
+ ```
189
+
190
+ ---
191
+
192
+ ### Antigravity
193
+
194
+ **HTTP** — `~/.gemini/config/mcp_config.json`
98
195
  ```json
99
196
  {
100
197
  "mcpServers": {
@@ -105,6 +202,48 @@ codex mcp add atlassian --url http://localhost:47001/mcp/atlassian
105
202
  }
106
203
  ```
107
204
 
205
+ **stdio** — `~/.gemini/config/mcp_config.json`
206
+ ```json
207
+ {
208
+ "mcpServers": {
209
+ "atlassian": {
210
+ "command": "localmcp",
211
+ "args": ["stdio", "atlassian"]
212
+ }
213
+ }
214
+ }
215
+ ```
216
+
217
+ ---
218
+
219
+ ## REST API
220
+
221
+ Call any Atlassian tool over plain HTTP — useful for scripts and automation.
222
+
223
+ ```bash
224
+ # List all tools
225
+ GET http://localhost:47001/api/atlassian
226
+
227
+ # Call a tool
228
+ POST http://localhost:47001/api/atlassian/getJiraIssue
229
+ Content-Type: application/json
230
+
231
+ {"issueIdOrKey": "PROJ-123"}
232
+
233
+ POST http://localhost:47001/api/atlassian/searchJiraIssuesUsingJql
234
+ Content-Type: application/json
235
+
236
+ {"jql": "project = PROJ AND status = \"In Progress\"", "maxResults": 20}
237
+ ```
238
+
239
+ Open the interactive playground:
240
+ ```bash
241
+ localmcp playground
242
+ # or: open http://localhost:47001/playground
243
+ ```
244
+
245
+ ---
246
+
108
247
  ## Tools
109
248
 
110
249
  ### Jira
package/docs/figma.md CHANGED
@@ -31,34 +31,82 @@ http://localhost:47001/mcp/figma
31
31
 
32
32
  ## Register with AI Agents
33
33
 
34
- **Claude Code**`.claude/settings.local.json`
34
+ Each agent supports two transports pick whichever fits your setup:
35
+
36
+ - **HTTP** — requires the server to be running (`localmcp`). Shared across agents.
37
+ - **stdio** — the agent spawns the process on demand. No running server needed.
38
+
39
+ Or use `localmcp register` to set up automatically.
40
+
41
+ ---
42
+
43
+ ### Claude Code
44
+
45
+ **HTTP** — `.claude/settings.local.json`
35
46
  ```json
36
47
  {
37
48
  "mcpServers": {
38
49
  "figma": {
50
+ "type": "http",
39
51
  "url": "http://localhost:47001/mcp/figma"
40
52
  }
41
53
  }
42
54
  }
43
55
  ```
44
56
 
57
+ **stdio** — `.claude/settings.local.json`
58
+ ```json
59
+ {
60
+ "mcpServers": {
61
+ "figma": {
62
+ "type": "stdio",
63
+ "command": "localmcp",
64
+ "args": ["stdio", "figma"]
65
+ }
66
+ }
67
+ }
68
+ ```
69
+
45
70
  Or register from the command line:
46
71
  ```bash
72
+ # HTTP
47
73
  claude mcp add --transport http figma http://localhost:47001/mcp/figma
74
+
75
+ # stdio
76
+ claude mcp add figma localmcp stdio figma
48
77
  ```
49
78
 
50
- **Codex** — `~/.codex/config.toml`
79
+ ---
80
+
81
+ ### Codex
82
+
83
+ **HTTP** — `~/.codex/config.toml`
51
84
  ```toml
52
85
  [mcp_servers.figma]
53
86
  url = "http://localhost:47001/mcp/figma"
54
87
  ```
55
88
 
89
+ **stdio** — `~/.codex/config.toml`
90
+ ```toml
91
+ [mcp_servers.figma]
92
+ command = "localmcp"
93
+ args = ["stdio", "figma"]
94
+ ```
95
+
56
96
  Or register from the command line:
57
97
  ```bash
98
+ # HTTP
58
99
  codex mcp add figma --url http://localhost:47001/mcp/figma
100
+
101
+ # stdio
102
+ codex mcp add figma localmcp stdio figma
59
103
  ```
60
104
 
61
- **GitHub Copilot / VS Code** — `.vscode/mcp.json`
105
+ ---
106
+
107
+ ### GitHub Copilot / VS Code
108
+
109
+ **HTTP** — `.vscode/mcp.json`
62
110
  ```json
63
111
  {
64
112
  "servers": {
@@ -70,7 +118,24 @@ codex mcp add figma --url http://localhost:47001/mcp/figma
70
118
  }
71
119
  ```
72
120
 
73
- **Cursor** — `.cursor/mcp.json`
121
+ **stdio** — `.vscode/mcp.json`
122
+ ```json
123
+ {
124
+ "servers": {
125
+ "figma": {
126
+ "type": "stdio",
127
+ "command": "localmcp",
128
+ "args": ["stdio", "figma"]
129
+ }
130
+ }
131
+ }
132
+ ```
133
+
134
+ ---
135
+
136
+ ### Cursor
137
+
138
+ **HTTP** — `.cursor/mcp.json`
74
139
  ```json
75
140
  {
76
141
  "mcpServers": {
@@ -81,7 +146,23 @@ codex mcp add figma --url http://localhost:47001/mcp/figma
81
146
  }
82
147
  ```
83
148
 
84
- **Windsurf** — `~/.codeium/windsurf/mcp_config.json`
149
+ **stdio** — `.cursor/mcp.json`
150
+ ```json
151
+ {
152
+ "mcpServers": {
153
+ "figma": {
154
+ "command": "localmcp",
155
+ "args": ["stdio", "figma"]
156
+ }
157
+ }
158
+ }
159
+ ```
160
+
161
+ ---
162
+
163
+ ### Windsurf
164
+
165
+ **HTTP** — `~/.codeium/windsurf/mcp_config.json`
85
166
  ```json
86
167
  {
87
168
  "mcpServers": {
@@ -92,7 +173,23 @@ codex mcp add figma --url http://localhost:47001/mcp/figma
92
173
  }
93
174
  ```
94
175
 
95
- **Antigravity** — `~/.gemini/config/mcp_config.json`
176
+ **stdio** — `~/.codeium/windsurf/mcp_config.json`
177
+ ```json
178
+ {
179
+ "mcpServers": {
180
+ "figma": {
181
+ "command": "localmcp",
182
+ "args": ["stdio", "figma"]
183
+ }
184
+ }
185
+ }
186
+ ```
187
+
188
+ ---
189
+
190
+ ### Antigravity
191
+
192
+ **HTTP** — `~/.gemini/config/mcp_config.json`
96
193
  ```json
97
194
  {
98
195
  "mcpServers": {
@@ -103,6 +200,48 @@ codex mcp add figma --url http://localhost:47001/mcp/figma
103
200
  }
104
201
  ```
105
202
 
203
+ **stdio** — `~/.gemini/config/mcp_config.json`
204
+ ```json
205
+ {
206
+ "mcpServers": {
207
+ "figma": {
208
+ "command": "localmcp",
209
+ "args": ["stdio", "figma"]
210
+ }
211
+ }
212
+ }
213
+ ```
214
+
215
+ ---
216
+
217
+ ## REST API
218
+
219
+ Call any Figma tool over plain HTTP — useful for scripts and automation.
220
+
221
+ ```bash
222
+ # List all tools
223
+ GET http://localhost:47001/api/figma
224
+
225
+ # Call a tool
226
+ POST http://localhost:47001/api/figma/figma_whoami
227
+ Content-Type: application/json
228
+
229
+ {}
230
+
231
+ POST http://localhost:47001/api/figma/figma_get_metadata
232
+ Content-Type: application/json
233
+
234
+ {"fileKey": "AbCdEfGh", "depth": 2}
235
+ ```
236
+
237
+ Open the interactive playground:
238
+ ```bash
239
+ localmcp playground
240
+ # or: open http://localhost:47001/playground
241
+ ```
242
+
243
+ ---
244
+
106
245
  ## Tools
107
246
 
108
247
  ### File & Node
@@ -43,34 +43,82 @@ http://localhost:47001/mcp/google-chat
43
43
 
44
44
  ## Register with AI Agents
45
45
 
46
- **Claude Code**`.claude/settings.local.json`
46
+ Each agent supports two transports pick whichever fits your setup:
47
+
48
+ - **HTTP** — requires the server to be running (`localmcp`). Shared across agents.
49
+ - **stdio** — the agent spawns the process on demand. No running server needed.
50
+
51
+ Or use `localmcp register` to set up automatically.
52
+
53
+ ---
54
+
55
+ ### Claude Code
56
+
57
+ **HTTP** — `.claude/settings.local.json`
47
58
  ```json
48
59
  {
49
60
  "mcpServers": {
50
61
  "google-chat": {
62
+ "type": "http",
51
63
  "url": "http://localhost:47001/mcp/google-chat"
52
64
  }
53
65
  }
54
66
  }
55
67
  ```
56
68
 
69
+ **stdio** — `.claude/settings.local.json`
70
+ ```json
71
+ {
72
+ "mcpServers": {
73
+ "google-chat": {
74
+ "type": "stdio",
75
+ "command": "localmcp",
76
+ "args": ["stdio", "google-chat"]
77
+ }
78
+ }
79
+ }
80
+ ```
81
+
57
82
  Or register from the command line:
58
83
  ```bash
84
+ # HTTP
59
85
  claude mcp add --transport http google-chat http://localhost:47001/mcp/google-chat
86
+
87
+ # stdio
88
+ claude mcp add google-chat localmcp stdio google-chat
60
89
  ```
61
90
 
62
- **Codex** — `~/.codex/config.toml`
91
+ ---
92
+
93
+ ### Codex
94
+
95
+ **HTTP** — `~/.codex/config.toml`
63
96
  ```toml
64
97
  [mcp_servers.google-chat]
65
98
  url = "http://localhost:47001/mcp/google-chat"
66
99
  ```
67
100
 
101
+ **stdio** — `~/.codex/config.toml`
102
+ ```toml
103
+ [mcp_servers.google-chat]
104
+ command = "localmcp"
105
+ args = ["stdio", "google-chat"]
106
+ ```
107
+
68
108
  Or register from the command line:
69
109
  ```bash
110
+ # HTTP
70
111
  codex mcp add google-chat --url http://localhost:47001/mcp/google-chat
112
+
113
+ # stdio
114
+ codex mcp add google-chat localmcp stdio google-chat
71
115
  ```
72
116
 
73
- **GitHub Copilot / VS Code** — `.vscode/mcp.json`
117
+ ---
118
+
119
+ ### GitHub Copilot / VS Code
120
+
121
+ **HTTP** — `.vscode/mcp.json`
74
122
  ```json
75
123
  {
76
124
  "servers": {
@@ -82,7 +130,24 @@ codex mcp add google-chat --url http://localhost:47001/mcp/google-chat
82
130
  }
83
131
  ```
84
132
 
85
- **Cursor** — `.cursor/mcp.json`
133
+ **stdio** — `.vscode/mcp.json`
134
+ ```json
135
+ {
136
+ "servers": {
137
+ "google-chat": {
138
+ "type": "stdio",
139
+ "command": "localmcp",
140
+ "args": ["stdio", "google-chat"]
141
+ }
142
+ }
143
+ }
144
+ ```
145
+
146
+ ---
147
+
148
+ ### Cursor
149
+
150
+ **HTTP** — `.cursor/mcp.json`
86
151
  ```json
87
152
  {
88
153
  "mcpServers": {
@@ -93,7 +158,23 @@ codex mcp add google-chat --url http://localhost:47001/mcp/google-chat
93
158
  }
94
159
  ```
95
160
 
96
- **Windsurf** — `~/.codeium/windsurf/mcp_config.json`
161
+ **stdio** — `.cursor/mcp.json`
162
+ ```json
163
+ {
164
+ "mcpServers": {
165
+ "google-chat": {
166
+ "command": "localmcp",
167
+ "args": ["stdio", "google-chat"]
168
+ }
169
+ }
170
+ }
171
+ ```
172
+
173
+ ---
174
+
175
+ ### Windsurf
176
+
177
+ **HTTP** — `~/.codeium/windsurf/mcp_config.json`
97
178
  ```json
98
179
  {
99
180
  "mcpServers": {
@@ -104,7 +185,23 @@ codex mcp add google-chat --url http://localhost:47001/mcp/google-chat
104
185
  }
105
186
  ```
106
187
 
107
- **Antigravity** — `~/.gemini/config/mcp_config.json`
188
+ **stdio** — `~/.codeium/windsurf/mcp_config.json`
189
+ ```json
190
+ {
191
+ "mcpServers": {
192
+ "google-chat": {
193
+ "command": "localmcp",
194
+ "args": ["stdio", "google-chat"]
195
+ }
196
+ }
197
+ }
198
+ ```
199
+
200
+ ---
201
+
202
+ ### Antigravity
203
+
204
+ **HTTP** — `~/.gemini/config/mcp_config.json`
108
205
  ```json
109
206
  {
110
207
  "mcpServers": {
@@ -115,6 +212,48 @@ codex mcp add google-chat --url http://localhost:47001/mcp/google-chat
115
212
  }
116
213
  ```
117
214
 
215
+ **stdio** — `~/.gemini/config/mcp_config.json`
216
+ ```json
217
+ {
218
+ "mcpServers": {
219
+ "google-chat": {
220
+ "command": "localmcp",
221
+ "args": ["stdio", "google-chat"]
222
+ }
223
+ }
224
+ }
225
+ ```
226
+
227
+ ---
228
+
229
+ ## REST API
230
+
231
+ Call any Google Chat tool over plain HTTP — useful for scripts and automation.
232
+
233
+ ```bash
234
+ # List all tools
235
+ GET http://localhost:47001/api/google-chat
236
+
237
+ # Call a tool
238
+ POST http://localhost:47001/api/google-chat/search_conversations
239
+ Content-Type: application/json
240
+
241
+ {"query": "team standup"}
242
+
243
+ POST http://localhost:47001/api/google-chat/send_message
244
+ Content-Type: application/json
245
+
246
+ {"conversationId": "spaces/AAAAAAA", "text": "Hello from the REST API!"}
247
+ ```
248
+
249
+ Open the interactive playground:
250
+ ```bash
251
+ localmcp playground
252
+ # or: open http://localhost:47001/playground
253
+ ```
254
+
255
+ ---
256
+
118
257
  ## Tools
119
258
 
120
259
  | Tool | Description |