@jadchene/mcp-gateway-service 0.4.2 → 0.4.3

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
@@ -215,30 +215,30 @@ A service is loaded only when `enable` is missing or set to `true`. If `enable`
215
215
 
216
216
  The gateway exposes a fixed set of discovery and routing tools:
217
217
 
218
- - `gateway.listServices`
219
- - `gateway.getService`
220
- - `gateway.listTools`
221
- - `gateway.getToolSchema`
222
- - `gateway.manageService`
223
- - `gateway.callTool`
218
+ - `gateway_list_services`
219
+ - `gateway_get_service`
220
+ - `gateway_list_tools`
221
+ - `gateway_get_tool_schema`
222
+ - `gateway_manage_service`
223
+ - `gateway_call_tool`
224
224
 
225
225
  ### Response design
226
226
 
227
- - `gateway.listServices` returns only `serviceId`, `description`, and `available`.
228
- - `gateway.listTools` returns only `name` and `description`; pass optional `toolName` as a string or string array to filter names by substring.
229
- - `gateway.getToolSchema` returns only `inputSchema` and `outputSchema`.
230
- - `gateway.manageService` returns only `serviceId`, `action`, `enabled`, and `available`.
231
- - `gateway.callTool` forwards the downstream MCP tool result directly without extra gateway metadata wrapping.
227
+ - `gateway_list_services` returns only `serviceId`, `description`, and `available`.
228
+ - `gateway_list_tools` returns only `name` and `description`; pass optional `toolName` as a string or string array to filter names by substring.
229
+ - `gateway_get_tool_schema` returns only `inputSchema` and `outputSchema`.
230
+ - `gateway_manage_service` returns only `serviceId`, `action`, `enabled`, and `available`.
231
+ - `gateway_call_tool` forwards the downstream MCP tool result directly without extra gateway metadata wrapping.
232
232
 
233
233
  ### Default workflow vs diagnostics
234
234
 
235
- - The default token-efficient workflow still uses four tools: `gateway.listServices`, `gateway.listTools`, `gateway.getToolSchema`, and `gateway.callTool`.
236
- - `gateway.getService` is primarily for diagnostics, such as checking recent service errors, connection state, protocol version, or downstream server info.
237
- - `gateway.manageService` is an operational tool for explicit service control, not part of the normal discovery flow.
235
+ - The default token-efficient workflow still uses four tools: `gateway_list_services`, `gateway_list_tools`, `gateway_get_tool_schema`, and `gateway_call_tool`.
236
+ - `gateway_get_service` is primarily for diagnostics, such as checking recent service errors, connection state, protocol version, or downstream server info.
237
+ - `gateway_manage_service` is an operational tool for explicit service control, not part of the normal discovery flow.
238
238
 
239
- ### `gateway.manageService`
239
+ ### `gateway_manage_service`
240
240
 
241
- Use `gateway.manageService` when you explicitly need to reconnect a service or persistently change its enabled state.
241
+ Use `gateway_manage_service` when you explicitly need to reconnect a service or persistently change its enabled state.
242
242
 
243
243
  Input:
244
244
 
@@ -260,12 +260,12 @@ Important notes:
260
260
 
261
261
  For the best token efficiency, the MCP client should cache discovery results instead of repeatedly querying the gateway:
262
262
 
263
- 1. Call `gateway.listServices` once at session start.
264
- 2. Call `gateway.listTools(serviceId)` only when a service is actually needed, optionally with `toolName` to narrow large tool lists by one or more keywords.
265
- 3. Call `gateway.getToolSchema(serviceId, toolName)` only before the first use of that tool.
266
- 4. Call `gateway.callTool(...)` for execution.
267
- 5. Use `gateway.getService` only when diagnostics are explicitly needed.
268
- 6. Use `gateway.manageService` only when a service must be reconnected or explicitly enabled/disabled.
263
+ 1. Call `gateway_list_services` once at session start.
264
+ 2. Call `gateway_list_tools(serviceId)` only when a service is actually needed, optionally with `toolName` to narrow large tool lists by one or more keywords.
265
+ 3. Call `gateway_get_tool_schema(serviceId, toolName)` only before the first use of that tool.
266
+ 4. Call `gateway_call_tool(...)` for execution.
267
+ 5. Use `gateway_get_service` only when diagnostics are explicitly needed.
268
+ 6. Use `gateway_manage_service` only when a service must be reconnected or explicitly enabled/disabled.
269
269
  7. Refresh discovery data only when a call fails, the config changes, or the client explicitly wants a refresh.
270
270
 
271
271
  ## Skill Integration (Recommended)
package/README_zh.md CHANGED
@@ -75,7 +75,7 @@
75
75
  ### 稳定的网关接口
76
76
  - 不动态展开所有下游工具。
77
77
  - 服务列表和工具列表返回精简结构。
78
- - `gateway.callTool` 直接透传下游工具返回结果,减少额外包装。
78
+ - `gateway_call_tool` 直接透传下游工具返回结果,减少额外包装。
79
79
 
80
80
  ### 实用运维能力
81
81
  - 从 JSON 配置文件加载静态服务池。
@@ -217,30 +217,30 @@ mcp-gateway-service -v
217
217
 
218
218
  ## 对外网关工具
219
219
 
220
- - `gateway.listServices`
221
- - `gateway.getService`
222
- - `gateway.listTools`
223
- - `gateway.getToolSchema`
224
- - `gateway.manageService`
225
- - `gateway.callTool`
220
+ - `gateway_list_services`
221
+ - `gateway_get_service`
222
+ - `gateway_list_tools`
223
+ - `gateway_get_tool_schema`
224
+ - `gateway_manage_service`
225
+ - `gateway_call_tool`
226
226
 
227
227
  ### 返回结构约定
228
228
 
229
- - `gateway.listServices` 只返回 `serviceId`、`description`、`available`
230
- - `gateway.listTools` 只返回 `name`、`description`,可传可选参数 `toolName`,支持字符串或字符串数组,按名称片段筛选
231
- - `gateway.getToolSchema` 只返回 `inputSchema`、`outputSchema`
232
- - `gateway.manageService` 只返回 `serviceId`、`action`、`enabled`、`available`
233
- - `gateway.callTool` 直接返回下游 MCP 的结果,不再额外包一层网关元数据
229
+ - `gateway_list_services` 只返回 `serviceId`、`description`、`available`
230
+ - `gateway_list_tools` 只返回 `name`、`description`,可传可选参数 `toolName`,支持字符串或字符串数组,按名称片段筛选
231
+ - `gateway_get_tool_schema` 只返回 `inputSchema`、`outputSchema`
232
+ - `gateway_manage_service` 只返回 `serviceId`、`action`、`enabled`、`available`
233
+ - `gateway_call_tool` 直接返回下游 MCP 的结果,不再额外包一层网关元数据
234
234
 
235
235
  ### 默认流程与诊断的区别
236
236
 
237
- - 默认的节省 token 工作流仍然只依赖 4 个工具:`gateway.listServices`、`gateway.listTools`、`gateway.getToolSchema`、`gateway.callTool`
238
- - `gateway.getService` 主要用于诊断,例如查看最近错误、连接状态、协议版本、下游服务信息
239
- - `gateway.manageService` 是显式运维控制工具,不属于日常 discovery 流程
237
+ - 默认的节省 token 工作流仍然只依赖 4 个工具:`gateway_list_services`、`gateway_list_tools`、`gateway_get_tool_schema`、`gateway_call_tool`
238
+ - `gateway_get_service` 主要用于诊断,例如查看最近错误、连接状态、协议版本、下游服务信息
239
+ - `gateway_manage_service` 是显式运维控制工具,不属于日常 discovery 流程
240
240
 
241
- ### `gateway.manageService`
241
+ ### `gateway_manage_service`
242
242
 
243
- 当你明确需要重新拉起某个服务,或者持久化修改某个服务的启用状态时,使用 `gateway.manageService`。
243
+ 当你明确需要重新拉起某个服务,或者持久化修改某个服务的启用状态时,使用 `gateway_manage_service`。
244
244
 
245
245
  输入参数:
246
246
 
@@ -262,12 +262,12 @@ mcp-gateway-service -v
262
262
 
263
263
  为了尽量节省 token,推荐由客户端缓存发现结果,而不是每次都重新调用网关:
264
264
 
265
- 1. 会话开始时调用一次 `gateway.listServices`
266
- 2. 真正需要某个服务时,再调用 `gateway.listTools(serviceId)`,工具很多时可传 `toolName` 用一个或多个关键词缩小结果范围
267
- 3. 第一次调用某个工具前,再调用 `gateway.getToolSchema(serviceId, toolName)`
268
- 4. 执行时调用 `gateway.callTool(...)`
269
- 5. 只有在明确需要诊断时才调用 `gateway.getService`
270
- 6. 只有在需要重新拉起服务或显式启用/停用服务时才调用 `gateway.manageService`
265
+ 1. 会话开始时调用一次 `gateway_list_services`
266
+ 2. 真正需要某个服务时,再调用 `gateway_list_tools(serviceId)`,工具很多时可传 `toolName` 用一个或多个关键词缩小结果范围
267
+ 3. 第一次调用某个工具前,再调用 `gateway_get_tool_schema(serviceId, toolName)`
268
+ 4. 执行时调用 `gateway_call_tool(...)`
269
+ 5. 只有在明确需要诊断时才调用 `gateway_get_service`
270
+ 6. 只有在需要重新拉起服务或显式启用/停用服务时才调用 `gateway_manage_service`
271
271
  7. 只有在调用失败、配置变更、或明确需要刷新时才重新发现
272
272
 
273
273
  ## Skill 集成(推荐)
@@ -79,19 +79,19 @@ export class McpGatewayEngine {
79
79
  const toolName = requireString(params.name, "The tool name must be a string.");
80
80
  const args = toObject(params.arguments ?? {}, "The tool arguments must be an object.");
81
81
  switch (toolName) {
82
- case "gateway.listServices":
82
+ case "gateway_list_services":
83
83
  return successContent({
84
84
  services: this.registry.listServices().map(formatServiceSummary)
85
85
  });
86
- case "gateway.getService":
86
+ case "gateway_get_service":
87
87
  return this.getService(args);
88
- case "gateway.listTools":
88
+ case "gateway_list_tools":
89
89
  return this.listTools(args);
90
- case "gateway.getToolSchema":
90
+ case "gateway_get_tool_schema":
91
91
  return this.getToolSchema(args);
92
- case "gateway.manageService":
92
+ case "gateway_manage_service":
93
93
  return this.manageService(args);
94
- case "gateway.callTool":
94
+ case "gateway_call_tool":
95
95
  return this.callDownstreamTool(args);
96
96
  default:
97
97
  throw new Error(`Unknown gateway tool '${toolName}'.`);
@@ -193,7 +193,7 @@ export class McpGatewayEngine {
193
193
  export function buildGatewayTools() {
194
194
  return [
195
195
  {
196
- name: "gateway.listServices",
196
+ name: "gateway_list_services",
197
197
  description: "Lists all MCP services currently managed by the gateway.",
198
198
  inputSchema: {
199
199
  type: "object",
@@ -202,14 +202,14 @@ export function buildGatewayTools() {
202
202
  }
203
203
  },
204
204
  {
205
- name: "gateway.getService",
205
+ name: "gateway_get_service",
206
206
  description: "Returns one service summary, runtime state, and metadata cache details.",
207
207
  inputSchema: objectSchema(["serviceId"], {
208
208
  serviceId: stringSchema("Logical service identifier.")
209
209
  })
210
210
  },
211
211
  {
212
- name: "gateway.listTools",
212
+ name: "gateway_list_tools",
213
213
  description: "Lists tools exposed by one downstream service, optionally filtered by one or more tool name keywords.",
214
214
  inputSchema: objectSchema(["serviceId"], {
215
215
  serviceId: stringSchema("Logical service identifier."),
@@ -228,7 +228,7 @@ export function buildGatewayTools() {
228
228
  })
229
229
  },
230
230
  {
231
- name: "gateway.getToolSchema",
231
+ name: "gateway_get_tool_schema",
232
232
  description: "Returns the input and output schema for one downstream tool.",
233
233
  inputSchema: objectSchema(["serviceId", "toolName"], {
234
234
  serviceId: stringSchema("Logical service identifier."),
@@ -236,7 +236,7 @@ export function buildGatewayTools() {
236
236
  })
237
237
  },
238
238
  {
239
- name: "gateway.manageService",
239
+ name: "gateway_manage_service",
240
240
  description: "Reconnects one service or updates its enabled state with a compact action.",
241
241
  inputSchema: objectSchema(["serviceId", "action"], {
242
242
  serviceId: stringSchema("Logical service identifier."),
@@ -248,7 +248,7 @@ export function buildGatewayTools() {
248
248
  })
249
249
  },
250
250
  {
251
- name: "gateway.callTool",
251
+ name: "gateway_call_tool",
252
252
  description: "Calls one downstream tool through the gateway service pool.",
253
253
  inputSchema: objectSchema(["serviceId", "toolName", "arguments"], {
254
254
  serviceId: stringSchema("Logical service identifier."),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jadchene/mcp-gateway-service",
3
- "version": "0.4.2",
3
+ "version": "0.4.3",
4
4
  "description": "A token-efficient MCP gateway that provides one unified entry point for multiple downstream MCP services.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -17,33 +17,35 @@ Operate downstream MCP services through the gateway's fixed, token-efficient dis
17
17
 
18
18
  ## Required Workflow
19
19
 
20
- 1. Call `gateway.listServices` once to find the right downstream service.
21
- 2. Call `gateway.listTools(serviceId)` only for the selected service, using optional `toolName` as a string or string array when one or more keywords can narrow a large tool list.
22
- 3. Call `gateway.getToolSchema(serviceId, toolName)` before the first use of that tool, or any time the arguments are not fully certain.
23
- 4. Call `gateway.callTool(serviceId, toolName, arguments)` for execution.
20
+ 1. Call `gateway_list_services` once to find the right downstream service.
21
+ 2. Call `gateway_list_tools(serviceId)` only for the selected service, using optional `toolName` as a string or string array when one or more keywords can narrow a large tool list.
22
+ 3. Call `gateway_get_tool_schema(serviceId, toolName)` before the first use of that tool, or any time the arguments are not fully certain.
23
+ 4. Call `gateway_call_tool(serviceId, toolName, arguments)` for execution.
24
24
  5. Re-discover only when a call fails, service availability changes, or the task clearly requires fresh metadata.
25
25
 
26
26
  ## Diagnostic Exception
27
27
 
28
- - Treat `gateway.getService` as a diagnostic tool, not part of the default workflow.
28
+ - Treat `gateway_get_service` as a diagnostic tool, not part of the default workflow.
29
29
  - Use it only when the user explicitly asks to inspect service health, connection state, protocol details, or recent service errors.
30
30
  - Do not call it during normal task execution when the four-tool flow is sufficient.
31
- - Treat `gateway.manageService` as an explicit service-control tool, not part of the default workflow.
32
- - Use `gateway.manageService({ serviceId, action: "reconnect" })` only when the user explicitly wants to retry starting a failed service after its dependency becomes ready.
33
- - Use `gateway.manageService({ serviceId, action: "enable" | "disable" })` only when the user explicitly wants to persistently change that service's enabled state in the config file.
31
+ - Treat `gateway_manage_service` as an explicit service-control tool, not part of the default workflow.
32
+ - Use `gateway_manage_service({ serviceId, action: "reconnect" })` only when the user explicitly wants to retry starting a failed service after its dependency becomes ready.
33
+ - Use `gateway_manage_service({ serviceId, action: "enable" | "disable" })` only when the user explicitly wants to persistently change that service's enabled state in the config file.
34
34
 
35
35
  ## Strict Argument Rule
36
36
 
37
- - If a tool has any non-trivial arguments, optional flags, confirmation fields, enum values, or write-safety fields, call `gateway.getToolSchema` before execution unless the exact argument contract is already confirmed in the current session.
37
+ - Treat every `serviceId` argument accepted by `gateway_*` tools as a downstream service identifier returned by `gateway_list_services`. Never pass `gateway`, a gateway-owned tool name, or any inferred self-reference as `serviceId`.
38
+ - If a tool has any non-trivial arguments, optional flags, confirmation fields, enum values, or write-safety fields, call `gateway_get_tool_schema` before execution unless the exact argument contract is already confirmed in the current session.
39
+ - Apply gateway discovery, schema, management, and routing tools only to downstream services and downstream tools. Do not use them to inspect or call gateway-owned tools such as `gateway_list_tools` or `gateway_call_tool`; gateway-owned tool schemas come from the MCP client's current gateway tool definitions.
38
40
  - Do not rely on tool descriptions alone when the argument shape could affect correctness or safety.
39
41
  - This is especially important for write tools, confirmation-based tools, and tools with nested argument objects.
40
42
 
41
43
  ## Response Shape Expectations
42
44
 
43
- - `gateway.listServices` returns compact service entries with `serviceId`, `description`, and `available`.
44
- - `gateway.listTools` returns compact tool entries with `name` and `description`, and supports optional substring filtering by `toolName` as a string or string array.
45
- - `gateway.getToolSchema` returns only `inputSchema` and `outputSchema`.
46
- - `gateway.callTool` forwards the downstream MCP result directly with minimal or no gateway wrapping.
45
+ - `gateway_list_services` returns compact service entries with `serviceId`, `description`, and `available`.
46
+ - `gateway_list_tools` returns compact tool entries with `name` and `description`, and supports optional substring filtering by `toolName` as a string or string array.
47
+ - `gateway_get_tool_schema` returns only `inputSchema` and `outputSchema`.
48
+ - `gateway_call_tool` forwards the downstream MCP result directly with minimal or no gateway wrapping.
47
49
 
48
50
  ## Token-Efficient Strategy
49
51
 
@@ -55,15 +57,15 @@ Operate downstream MCP services through the gateway's fixed, token-efficient dis
55
57
  ## Common Patterns
56
58
 
57
59
  - Need a service for one task domain:
58
- - `gateway.listServices`
60
+ - `gateway_list_services`
59
61
  - choose the most relevant `serviceId`
60
- - `gateway.listTools({ serviceId: "selected-service", toolName: "optional-keyword" })`
61
- - `gateway.listTools({ serviceId: "selected-service", toolName: ["keyword-a", "keyword-b"] })`
62
- - `gateway.getToolSchema({ serviceId: "selected-service", toolName: "selected-tool" })`
63
- - `gateway.callTool({ serviceId: "selected-service", toolName: "selected-tool", arguments: {...} })`
62
+ - `gateway_list_tools({ serviceId: "selected-service", toolName: "optional-keyword" })`
63
+ - `gateway_list_tools({ serviceId: "selected-service", toolName: ["keyword-a", "keyword-b"] })`
64
+ - `gateway_get_tool_schema({ serviceId: "selected-service", toolName: "selected-tool" })`
65
+ - `gateway_call_tool({ serviceId: "selected-service", toolName: "selected-tool", arguments: {...} })`
64
66
 
65
67
  - Need to inspect an unfamiliar tool before first use, or any tool whose arguments are not fully certain:
66
- - `gateway.getToolSchema({ serviceId: "selected-service", toolName: "selected-tool" })`
68
+ - `gateway_get_tool_schema({ serviceId: "selected-service", toolName: "selected-tool" })`
67
69
  - build arguments strictly from `inputSchema`
68
70
  - call the tool only after the schema is understood
69
71
 
@@ -71,7 +73,7 @@ Operate downstream MCP services through the gateway's fixed, token-efficient dis
71
73
 
72
74
  - **Never** flatten all downstream tools into your own notes unless the task explicitly needs a full inventory.
73
75
  - **Never** invent arguments for a tool when the schema can be queried cheaply.
74
- - **Never** skip `gateway.getToolSchema` when argument names or fields are unclear.
76
+ - **Never** skip `gateway_get_tool_schema` when argument names or fields are unclear.
75
77
  - **Never** assume a service is available without checking recent gateway discovery results when availability matters.
76
78
 
77
79
  ## Practical Guidance