apcore-mcp 0.3.0 → 0.5.0

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 (38) hide show
  1. package/dist/adapters/annotations.d.ts +6 -2
  2. package/dist/adapters/annotations.d.ts.map +1 -1
  3. package/dist/adapters/annotations.js +27 -9
  4. package/dist/adapters/annotations.js.map +1 -1
  5. package/dist/cli.d.ts.map +1 -1
  6. package/dist/cli.js +20 -5
  7. package/dist/cli.js.map +1 -1
  8. package/dist/explorer/handler.d.ts +55 -0
  9. package/dist/explorer/handler.d.ts.map +1 -0
  10. package/dist/explorer/handler.js +175 -0
  11. package/dist/explorer/handler.js.map +1 -0
  12. package/dist/explorer/html.d.ts +9 -0
  13. package/dist/explorer/html.d.ts.map +1 -0
  14. package/dist/explorer/html.js +238 -0
  15. package/dist/explorer/html.js.map +1 -0
  16. package/dist/explorer/index.d.ts +6 -0
  17. package/dist/explorer/index.d.ts.map +1 -0
  18. package/dist/explorer/index.js +5 -0
  19. package/dist/explorer/index.js.map +1 -0
  20. package/dist/index.d.ts +41 -2
  21. package/dist/index.d.ts.map +1 -1
  22. package/dist/index.js +102 -18
  23. package/dist/index.js.map +1 -1
  24. package/dist/server/factory.d.ts +12 -0
  25. package/dist/server/factory.d.ts.map +1 -1
  26. package/dist/server/factory.js +73 -9
  27. package/dist/server/factory.js.map +1 -1
  28. package/dist/server/router.d.ts +7 -1
  29. package/dist/server/router.d.ts.map +1 -1
  30. package/dist/server/router.js +65 -5
  31. package/dist/server/router.js.map +1 -1
  32. package/dist/server/transport.d.ts +55 -1
  33. package/dist/server/transport.d.ts.map +1 -1
  34. package/dist/server/transport.js +114 -1
  35. package/dist/server/transport.js.map +1 -1
  36. package/dist/types.d.ts +4 -1
  37. package/dist/types.d.ts.map +1 -1
  38. package/package.json +19 -2
package/dist/explorer/html.js ADDED
@@ -0,0 +1,238 @@
1
+ /**
2
+ * Self-contained HTML page for the MCP Tool Explorer.
3
+ *
4
+ * Single-page application with no external dependencies.
5
+ * Displays registered MCP tools, their schemas, annotations,
6
+ * and optionally allows executing tools from the browser.
7
+ */
8
+ export const EXPLORER_HTML = `\
9
+ <!DOCTYPE html>
10
+ <html lang="en">
11
+ <head>
12
+ <meta charset="utf-8">
13
+ <meta name="viewport" content="width=device-width, initial-scale=1">
14
+ <title>MCP Tool Explorer</title>
15
+ <style>
16
+ * { margin: 0; padding: 0; box-sizing: border-box; }
17
+ body { font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, monospace;
18
+ background: #f5f5f5; color: #333; padding: 24px; }
19
+ h1 { font-size: 1.4rem; margin-bottom: 16px; }
20
+ .tool-list { list-style: none; }
21
+ .tool-item { background: #fff; border: 1px solid #ddd; border-radius: 6px;
22
+ padding: 12px 16px; margin-bottom: 8px; cursor: pointer; }
23
+ .tool-item:hover { border-color: #888; }
24
+ .tool-name { font-weight: 600; }
25
+ .tool-desc { color: #666; font-size: 0.9rem; margin-top: 4px; }
26
+ .hint { display: inline-block; background: #e8e8e8; padding: 2px 8px;
27
+ border-radius: 3px; font-size: 0.75rem; margin-right: 4px; }
28
+ .hint-readonly { background: #d4edda; color: #155724; }
29
+ .hint-destructive { background: #f8d7da; color: #721c24; }
30
+ .hint-idempotent { background: #cce5ff; color: #004085; }
31
+ .detail { background: #fff; border: 1px solid #ddd; border-radius: 6px;
32
+ padding: 16px; margin-top: 16px; display: none; }
33
+ .detail.active { display: block; }
34
+ .detail h2 { font-size: 1.1rem; margin-bottom: 12px; }
35
+ .schema-label { font-weight: 600; margin-top: 12px; display: block; }
36
+ pre { background: #282c34; color: #abb2bf; padding: 12px; border-radius: 4px;
37
+ overflow-x: auto; font-size: 0.85rem; margin-top: 4px; }
38
+ #loading { color: #888; }
39
+ .try-it { margin-top: 16px; border-top: 1px solid #eee; padding-top: 16px; }
40
+ .try-it h3 { font-size: 0.95rem; margin-bottom: 8px; }
41
+ .input-editor { width: 100%; min-height: 120px; font-family: monospace;
42
+ font-size: 0.85rem; padding: 10px; border: 1px solid #ddd;
43
+ border-radius: 4px; resize: vertical; background: #fafafa; }
44
+ .execute-btn { margin-top: 8px; padding: 8px 20px; background: #4CAF50; color: #fff;
45
+ border: none; border-radius: 4px; cursor: pointer; font-size: 0.9rem;
46
+ font-weight: 600; }
47
+ .execute-btn:hover { background: #45a049; }
48
+ .execute-btn:disabled { background: #ccc; cursor: not-allowed; }
49
+ .result-area { margin-top: 12px; }
50
+ .result-area pre { background: #1a2332; }
51
+ .result-error { color: #f93e3e; }
52
+ .result-success { color: #49cc90; }
53
+ .exec-disabled { color: #888; font-size: 0.85rem; font-style: italic; margin-top: 16px; }
54
+ </style>
55
+ </head>
56
+ <body>
57
+ <h1>MCP Tool Explorer</h1>
58
+ <div id="loading">Loading tools...</div>
59
+ <ul class="tool-list" id="tools"></ul>
60
+ <div class="detail" id="detail"></div>
61
+ <script>
62
+ (function() {
63
+ var base = window.location.pathname.replace(/\\/$/, '');
64
+ var toolsEl = document.getElementById('tools');
65
+ var detailEl = document.getElementById('detail');
66
+ var loadingEl = document.getElementById('loading');
67
+ var executeEnabled = null;
68
+
69
+ function esc(s) {
70
+ var d = document.createElement('div');
71
+ d.appendChild(document.createTextNode(s));
72
+ return d.innerHTML;
73
+ }
74
+
75
+ function defaultFromSchema(schema) {
76
+ if (!schema || !schema.properties) return {};
77
+ var result = {};
78
+ var props = schema.properties;
79
+ for (var key in props) {
80
+ if (!props.hasOwnProperty(key)) continue;
81
+ var t = props[key].type;
82
+ if (props[key]['default'] !== undefined) {
83
+ result[key] = props[key]['default'];
84
+ } else if (t === 'string') {
85
+ result[key] = '';
86
+ } else if (t === 'number' || t === 'integer') {
87
+ result[key] = 0;
88
+ } else if (t === 'boolean') {
89
+ result[key] = false;
90
+ } else if (t === 'array') {
91
+ result[key] = [];
92
+ } else if (t === 'object') {
93
+ result[key] = {};
94
+ } else {
95
+ result[key] = null;
96
+ }
97
+ }
98
+ return result;
99
+ }
100
+
101
+ function hintsHtml(annotations) {
102
+ if (!annotations) return '';
103
+ var parts = [];
104
+ if (annotations.readOnlyHint) parts.push('<span class="hint hint-readonly">readOnly</span>');
105
+ if (annotations.destructiveHint) parts.push('<span class="hint hint-destructive">destructive</span>');
106
+ if (annotations.idempotentHint) parts.push('<span class="hint hint-idempotent">idempotent</span>');
107
+ if (annotations.openWorldHint === false) parts.push('<span class="hint">closedWorld</span>');
108
+ return parts.join('');
109
+ }
110
+
111
+ fetch(base + '/tools')
112
+ .then(function(r) { return r.json(); })
113
+ .then(function(tools) {
114
+ loadingEl.style.display = 'none';
115
+ tools.forEach(function(t) {
116
+ var li = document.createElement('li');
117
+ li.className = 'tool-item';
118
+ li.innerHTML =
119
+ '<span class="tool-name">' + esc(t.name) + '</span> ' +
120
+ hintsHtml(t.annotations) +
121
+ '<div class="tool-desc">' + esc(t.description || '') + '</div>';
122
+ li.onclick = function() { loadDetail(t.name); };
123
+ toolsEl.appendChild(li);
124
+ });
125
+ fetch(base + '/tools/__probe__/call', {
126
+ method: 'POST',
127
+ headers: {'Content-Type': 'application/json'},
128
+ body: '{}'
129
+ }).then(function(r) {
130
+ executeEnabled = r.status !== 403;
131
+ }).catch(function() {});
132
+ })
133
+ .catch(function(e) { loadingEl.textContent = 'Error: ' + e; });
134
+
135
+ function loadDetail(name) {
136
+ fetch(base + '/tools/' + encodeURIComponent(name))
137
+ .then(function(r) { return r.json(); })
138
+ .then(function(d) {
139
+ detailEl.className = 'detail active';
140
+ var html =
141
+ '<h2>' + esc(d.name) + '</h2>' +
142
+ '<p>' + esc(d.description || '') + '</p>' +
143
+ '<span class="schema-label">Input Schema</span>' +
144
+ '<pre>' + esc(JSON.stringify(d.inputSchema, null, 2)) + '</pre>';
145
+
146
+ if (d.annotations) {
147
+ html += '<span class="schema-label">Annotations</span>' +
148
+ '<pre>' + esc(JSON.stringify(d.annotations, null, 2)) + '</pre>';
149
+ }
150
+
151
+ html += '<div class="try-it" id="try-it-section">' +
152
+ '<h3>Try it</h3>' +
153
+ '<textarea class="input-editor" id="input-editor">' +
154
+ esc(JSON.stringify(defaultFromSchema(d.inputSchema), null, 2)) +
155
+ '</textarea>' +
156
+ '<button class="execute-btn" id="execute-btn">Execute</button>' +
157
+ '<div class="result-area" id="result-area"></div>' +
158
+ '</div>';
159
+
160
+ detailEl.innerHTML = html;
161
+
162
+ document.getElementById('execute-btn').onclick = function() {
163
+ execTool(d.name);
164
+ };
165
+
166
+ if (executeEnabled === false) {
167
+ var section = document.getElementById('try-it-section');
168
+ if (section) section.innerHTML =
169
+ '<p class="exec-disabled">' +
170
+ 'Tool execution is disabled. ' +
171
+ 'Launch with --allow-execute to enable.</p>';
172
+ }
173
+ })
174
+ .catch(function(e) {
175
+ detailEl.className = 'detail active';
176
+ detailEl.innerHTML = '<p class="result-error">Failed to load tool details: ' + esc(e.message) + '</p>';
177
+ });
178
+ }
179
+
180
+ function execTool(name) {
181
+ var btn = document.getElementById('execute-btn');
182
+ var editor = document.getElementById('input-editor');
183
+ var resultArea = document.getElementById('result-area');
184
+
185
+ var inputText = editor.value.trim();
186
+ var inputs;
187
+ try {
188
+ inputs = inputText ? JSON.parse(inputText) : {};
189
+ } catch (e) {
190
+ resultArea.innerHTML = '<p class="result-error">Invalid JSON: ' + esc(e.message) + '</p>';
191
+ return;
192
+ }
193
+
194
+ btn.disabled = true;
195
+ btn.textContent = 'Executing...';
196
+ resultArea.innerHTML = '';
197
+
198
+ fetch(base + '/tools/' + encodeURIComponent(name) + '/call', {
199
+ method: 'POST',
200
+ headers: {'Content-Type': 'application/json'},
201
+ body: JSON.stringify(inputs)
202
+ })
203
+ .then(function(r) {
204
+ if (r.status === 403) {
205
+ executeEnabled = false;
206
+ var section = document.getElementById('try-it-section');
207
+ if (section) section.innerHTML =
208
+ '<p class="exec-disabled">' +
209
+ 'Tool execution is disabled. ' +
210
+ 'Launch with --allow-execute to enable.</p>';
211
+ return null;
212
+ }
213
+ return r.json().then(function(data) { return {status: r.status, data: data}; });
214
+ })
215
+ .then(function(result) {
216
+ if (!result) return;
217
+ btn.disabled = false;
218
+ btn.textContent = 'Execute';
219
+ if (result.status >= 400) {
220
+ resultArea.innerHTML = '<span class="schema-label result-error">Error (' + result.status + ')</span>' +
221
+ '<pre>' + esc(JSON.stringify(result.data, null, 2)) + '</pre>';
222
+ } else {
223
+ resultArea.innerHTML = '<span class="schema-label result-success">Result</span>' +
224
+ '<pre>' + esc(JSON.stringify(result.data, null, 2)) + '</pre>';
225
+ }
226
+ })
227
+ .catch(function(e) {
228
+ btn.disabled = false;
229
+ btn.textContent = 'Execute';
230
+ resultArea.innerHTML = '<p class="result-error">Request failed: ' + esc(e.message) + '</p>';
231
+ });
232
+ }
233
+ })();
234
+ </script>
235
+ </body>
236
+ </html>
237
+ `;
238
+ //# sourceMappingURL=html.js.map
package/dist/explorer/html.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"html.js","sourceRoot":"","sources":["../../src/explorer/html.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqO5B,CAAC"}
package/dist/explorer/index.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ /**
2
+ * MCP Tool Explorer: browser-based UI for inspecting and testing MCP tools.
3
+ */
4
+ export { ExplorerHandler } from "./handler.js";
5
+ export type { ExplorerHandlerOptions } from "./handler.js";
6
+ //# sourceMappingURL=index.d.ts.map
package/dist/explorer/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/explorer/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,YAAY,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC"}
package/dist/explorer/index.js ADDED
@@ -0,0 +1,5 @@
1
+ /**
2
+ * MCP Tool Explorer: browser-based UI for inspecting and testing MCP tools.
3
+ */
4
+ export { ExplorerHandler } from "./handler.js";
5
+ //# sourceMappingURL=index.js.map
package/dist/explorer/index.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/explorer/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC"}
package/dist/index.d.ts CHANGED
@@ -6,7 +6,8 @@
6
6
  * - toOpenaiTools(registryOrExecutor, options?) - Export OpenAI tool definitions
7
7
  */
8
8
  import type { ConvertRegistryOptions } from "./converters/openai.js";
9
- import type { RegistryOrExecutor, OpenAIToolDef } from "./types.js";
9
+ import type { MetricsExporter } from "./server/transport.js";
10
+ import type { RegistryOrExecutor, Registry, Executor, OpenAIToolDef } from "./types.js";
10
11
  export declare const VERSION: string;
11
12
  export type { Registry, Executor, RegistryOrExecutor, OpenAIToolDef } from "./types.js";
12
13
  export type { ModuleDescriptor, ModuleAnnotations, JsonSchema, ModuleError, McpAnnotationsDict, McpErrorResponse, TextContentDict, } from "./types.js";
@@ -17,9 +18,12 @@ export { createBridgeContext } from "./server/context.js";
17
18
  export type { BridgeContext } from "./server/context.js";
18
19
  export { MCPServerFactory } from "./server/factory.js";
19
20
  export { ExecutionRouter } from "./server/router.js";
20
- export type { CallResult, HandleCallExtra } from "./server/router.js";
21
+ export type { CallResult, HandleCallExtra, ExecutionRouterOptions } from "./server/router.js";
21
22
  export { RegistryListener } from "./server/listener.js";
22
23
  export { TransportManager } from "./server/transport.js";
24
+ export type { MetricsExporter } from "./server/transport.js";
25
+ export { ExplorerHandler } from "./explorer/index.js";
26
+ export type { ExplorerHandlerOptions } from "./explorer/index.js";
23
27
  export { AnnotationMapper } from "./adapters/annotations.js";
24
28
  export { SchemaConverter } from "./adapters/schema.js";
25
29
  export { ErrorMapper } from "./adapters/errors.js";
@@ -27,6 +31,23 @@ export { ModuleIDNormalizer } from "./adapters/idNormalizer.js";
27
31
  export { OpenAIConverter } from "./converters/openai.js";
28
32
  export type { ConvertOptions, ConvertRegistryOptions } from "./converters/openai.js";
29
33
  export type { BuildToolsOptions } from "./server/factory.js";
34
+ /**
35
+ * Extract Registry from either a Registry or Executor instance.
36
+ *
37
+ * If the argument has a `registry` property (i.e. it's an Executor),
38
+ * returns that property. Otherwise assumes it's a Registry and returns it directly.
39
+ */
40
+ export declare function resolveRegistry(registryOrExecutor: RegistryOrExecutor): Registry;
41
+ /**
42
+ * Get or create an Executor from either a Registry or Executor instance.
43
+ *
44
+ * If the argument already has `call` or `callAsync`, returns it directly.
45
+ * If a bare Registry is passed, attempts to dynamically import the Executor
46
+ * from apcore-js and create a default instance (matching Python's resolve_executor).
47
+ *
48
+ * @throws {Error} If the argument is a Registry and apcore-js is not installed.
49
+ */
50
+ export declare function resolveExecutor(registryOrExecutor: RegistryOrExecutor): Executor;
30
51
  /** Options for serve() */
31
52
  export interface ServeOptions {
32
53
  /** Transport type. Default: "stdio" */
@@ -43,6 +64,24 @@ export interface ServeOptions {
43
64
  dynamic?: boolean;
44
65
  /** Enable input validation against schemas. Default: false */
45
66
  validateInputs?: boolean;
67
+ /** Filter modules by tags. Default: null (no filtering) */
68
+ tags?: string[] | null;
69
+ /** Filter modules by prefix. Default: null (no filtering) */
70
+ prefix?: string | null;
71
+ /** Minimum log level. Suppresses console methods below this level. Default: undefined (no suppression) */
72
+ logLevel?: "DEBUG" | "INFO" | "WARNING" | "ERROR" | "CRITICAL";
73
+ /** Callback invoked before the server starts. */
74
+ onStartup?: () => void | Promise<void>;
75
+ /** Callback invoked after the server stops (or on error). */
76
+ onShutdown?: () => void | Promise<void>;
77
+ /** Optional MetricsCollector for Prometheus /metrics endpoint. */
78
+ metricsCollector?: MetricsExporter;
79
+ /** Enable the browser-based Tool Explorer UI (HTTP transports only). Default: false */
80
+ explorer?: boolean;
81
+ /** URL prefix for the explorer. Default: "/explorer" */
82
+ explorerPrefix?: string;
83
+ /** Allow tool execution from the explorer UI. Default: false */
84
+ allowExecute?: boolean;
46
85
  }
47
86
  /**
48
87
  * Launch an MCP Server that exposes all apcore modules as tools.
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAIrE,OAAO,KAAK,EACV,kBAAkB,EAGlB,aAAa,EACd,MAAM,YAAY,CAAC;AAIpB,eAAO,MAAM,OAAO,EAAE,MAAoB,CAAC;AAG3C,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACxF,YAAY,EACV,gBAAgB,EAChB,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAG5E,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACxF,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACrF,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AA8B7D,0BAA0B;AAC1B,MAAM,WAAW,YAAY;IAC3B,uCAAuC;IACvC,SAAS,CAAC,EAAE,OAAO,GAAG,iBAAiB,GAAG,KAAK,CAAC;IAChD,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8DAA8D;IAC9D,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;GAKG;AACH,wBAAsB,KAAK,CACzB,kBAAkB,EAAE,kBAAkB,EACtC,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,IAAI,CAAC,CAqCf;AAED,kCAAkC;AAClC,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;CAAG;AAEvE;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,kBAAkB,EAAE,kBAAkB,EACtC,OAAO,GAAE,oBAAyB,GACjC,aAAa,EAAE,CAKjB"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAIrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,KAAK,EACV,kBAAkB,EAClB,QAAQ,EACR,QAAQ,EACR,aAAa,EACd,MAAM,YAAY,CAAC;AAIpB,eAAO,MAAM,OAAO,EAAE,MAAoB,CAAC;AAG3C,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACxF,YAAY,EACV,gBAAgB,EAChB,iBAAiB,EACjB,UAAU,EACV,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAG5E,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACxF,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,YAAY,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC9F,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,YAAY,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACrF,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,QAAQ,CAOhF;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,QAAQ,CAmBhF;AAED,0BAA0B;AAC1B,MAAM,WAAW,YAAY;IAC3B,uCAAuC;IACvC,SAAS,CAAC,EAAE,OAAO,GAAG,iBAAiB,GAAG,KAAK,CAAC;IAChD,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8DAA8D;IAC9D,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACvB,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,0GAA0G;IAC1G,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,UAAU,CAAC;IAC/D,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,6DAA6D;IAC7D,UAAU,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,kEAAkE;IAClE,gBAAgB,CAAC,EAAE,eAAe,CAAC;IACnC,uFAAuF;IACvF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,wDAAwD;IACxD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gEAAgE;IAChE,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;GAKG;AACH,wBAAsB,KAAK,CACzB,kBAAkB,EAAE,kBAAkB,EACtC,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC,IAAI,CAAC,CA+Gf;AAED,kCAAkC;AAClC,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;CAAG;AAEvE;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,kBAAkB,EAAE,kBAAkB,EACtC,OAAO,GAAE,oBAAyB,GACjC,aAAa,EAAE,CAKjB"}
package/dist/index.js CHANGED
@@ -10,6 +10,7 @@ import { OpenAIConverter } from "./converters/openai.js";
10
10
  import { MCPServerFactory } from "./server/factory.js";
11
11
  import { ExecutionRouter } from "./server/router.js";
12
12
  import { TransportManager } from "./server/transport.js";
13
+ import { ExplorerHandler } from "./explorer/handler.js";
13
14
  const require = createRequire(import.meta.url);
14
15
  const pkg = require("../package.json");
15
16
  export const VERSION = pkg.version;
@@ -22,6 +23,7 @@ export { MCPServerFactory } from "./server/factory.js";
22
23
  export { ExecutionRouter } from "./server/router.js";
23
24
  export { RegistryListener } from "./server/listener.js";
24
25
  export { TransportManager } from "./server/transport.js";
26
+ export { ExplorerHandler } from "./explorer/index.js";
25
27
  export { AnnotationMapper } from "./adapters/annotations.js";
26
28
  export { SchemaConverter } from "./adapters/schema.js";
27
29
  export { ErrorMapper } from "./adapters/errors.js";
@@ -29,8 +31,11 @@ export { ModuleIDNormalizer } from "./adapters/idNormalizer.js";
29
31
  export { OpenAIConverter } from "./converters/openai.js";
30
32
  /**
31
33
  * Extract Registry from either a Registry or Executor instance.
34
+ *
35
+ * If the argument has a `registry` property (i.e. it's an Executor),
36
+ * returns that property. Otherwise assumes it's a Registry and returns it directly.
32
37
  */
33
- function resolveRegistry(registryOrExecutor) {
38
+ export function resolveRegistry(registryOrExecutor) {
34
39
  if ("registry" in registryOrExecutor) {
35
40
  // It's an Executor — get its registry
36
41
  return registryOrExecutor.registry;
@@ -40,16 +45,31 @@ function resolveRegistry(registryOrExecutor) {
40
45
  }
41
46
  /**
42
47
  * Get or create an Executor from either a Registry or Executor instance.
48
+ *
49
+ * If the argument already has `call` or `callAsync`, returns it directly.
50
+ * If a bare Registry is passed, attempts to dynamically import the Executor
51
+ * from apcore-js and create a default instance (matching Python's resolve_executor).
52
+ *
53
+ * @throws {Error} If the argument is a Registry and apcore-js is not installed.
43
54
  */
44
- function resolveExecutor(registryOrExecutor) {
55
+ export function resolveExecutor(registryOrExecutor) {
45
56
  if ("call" in registryOrExecutor || "callAsync" in registryOrExecutor) {
46
57
  // Already an Executor
47
58
  return registryOrExecutor;
48
59
  }
49
- // It's a Registry — the caller must provide an Executor
50
- // Since we don't import apcore directly, we create a minimal wrapper
51
- throw new Error("serve() requires an Executor instance when not using a Registry with a built-in executor. " +
52
- "Please pass an Executor instead of a Registry.");
60
+ // It's a bare Registry — create a default Executor
61
+ try {
62
+ // eslint-disable-next-line @typescript-eslint/no-require-imports
63
+ const apcore = require("apcore-js");
64
+ const ExecutorClass = apcore.Executor ?? apcore.default?.Executor;
65
+ if (ExecutorClass) {
66
+ return new ExecutorClass({ registry: registryOrExecutor });
67
+ }
68
+ }
69
+ catch {
70
+ // apcore-js not installed — fall through to error
71
+ }
72
+ throw new Error("serve() requires an Executor instance, or apcore-js must be installed to auto-create one from a Registry.");
53
73
  }
54
74
  /**
55
75
  * Launch an MCP Server that exposes all apcore modules as tools.
@@ -58,29 +78,93 @@ function resolveExecutor(registryOrExecutor) {
58
78
  * @param options - Server configuration options.
59
79
  */
60
80
  export async function serve(registryOrExecutor, options = {}) {
61
- const { transport = "stdio", host = "127.0.0.1", port = 8000, name = "apcore-mcp", version = VERSION, } = options;
81
+ const { transport = "stdio", host = "127.0.0.1", port = 8000, name = "apcore-mcp", version = VERSION, validateInputs, tags, prefix, logLevel, onStartup, onShutdown, metricsCollector, explorer = false, explorerPrefix = "/explorer", allowExecute = false, } = options;
82
+ // Input validation (matching Python's checks)
83
+ if (!name || name.length === 0) {
84
+ throw new Error("name must not be empty");
85
+ }
86
+ if (name.length > 255) {
87
+ throw new Error("name must not exceed 255 characters");
88
+ }
89
+ if (tags) {
90
+ for (const tag of tags) {
91
+ if (!tag || tag.length === 0) {
92
+ throw new Error("tags must not contain empty strings");
93
+ }
94
+ }
95
+ }
96
+ if (prefix !== undefined && prefix !== null && prefix.length === 0) {
97
+ throw new Error("prefix must not be empty if provided");
98
+ }
99
+ if (explorer && !explorerPrefix.startsWith("/")) {
100
+ throw new Error("explorerPrefix must start with '/'");
101
+ }
102
+ // Save original console methods before suppression
103
+ const origDebug = console.debug;
104
+ const origInfo = console.info;
105
+ const origWarn = console.warn;
106
+ const origError = console.error;
107
+ // Apply log-level suppression
108
+ if (logLevel) {
109
+ const levels = ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"];
110
+ const minLevel = levels.indexOf(logLevel);
111
+ if (minLevel > 0)
112
+ console.debug = () => { };
113
+ if (minLevel > 1)
114
+ console.info = () => { };
115
+ if (minLevel > 2)
116
+ console.warn = () => { };
117
+ if (minLevel > 3)
118
+ console.error = () => { };
119
+ }
62
120
  const registry = resolveRegistry(registryOrExecutor);
63
121
  const executor = resolveExecutor(registryOrExecutor);
64
122
  // Build MCP server components
65
123
  const factory = new MCPServerFactory();
66
124
  const server = factory.createServer(name, version);
67
- const tools = factory.buildTools(registry);
68
- const router = new ExecutionRouter(executor);
125
+ const tools = factory.buildTools(registry, { tags, prefix });
126
+ const router = new ExecutionRouter(executor, { validateInputs });
69
127
  factory.registerHandlers(server, tools, router);
70
- console.info(`Starting MCP server '${name}' v${version} with ${tools.length} tools via ${transport}`);
128
+ factory.registerResourceHandlers(server, registry);
129
+ origInfo(`Starting MCP server '${name}' v${version} with ${tools.length} tools via ${transport}`);
130
+ // Invoke startup callback
131
+ await onStartup?.();
71
132
  // Select and run transport
72
133
  const transportManager = new TransportManager();
73
- if (transport === "stdio") {
74
- await transportManager.runStdio(server);
134
+ transportManager.setModuleCount(tools.length);
135
+ if (metricsCollector) {
136
+ transportManager.setMetricsCollector(metricsCollector);
75
137
  }
76
- else if (transport === "streamable-http") {
77
- await transportManager.runStreamableHttp(server, { host, port });
138
+ // Mount explorer for HTTP transports only
139
+ const transportLower = transport.toLowerCase();
140
+ if (explorer && (transportLower === "streamable-http" || transportLower === "sse")) {
141
+ const explorerHandler = new ExplorerHandler(tools, router, {
142
+ allowExecute,
143
+ prefix: explorerPrefix,
144
+ });
145
+ transportManager.setExplorerHandler(explorerHandler);
146
+ origInfo(`Tool Explorer enabled at ${explorerPrefix}`);
78
147
  }
79
- else if (transport === "sse") {
80
- await transportManager.runSse(server, { host, port });
148
+ try {
149
+ if (transport === "stdio") {
150
+ await transportManager.runStdio(server);
151
+ }
152
+ else if (transport === "streamable-http") {
153
+ await transportManager.runStreamableHttp(server, { host, port });
154
+ }
155
+ else if (transport === "sse") {
156
+ await transportManager.runSse(server, { host, port });
157
+ }
158
+ else {
159
+ throw new Error(`Unknown transport: '${transport}'. Expected 'stdio', 'streamable-http', or 'sse'.`);
160
+ }
81
161
  }
82
- else {
83
- throw new Error(`Unknown transport: '${transport}'. Expected 'stdio', 'streamable-http', or 'sse'.`);
162
+ finally {
163
+ console.debug = origDebug;
164
+ console.info = origInfo;
165
+ console.warn = origWarn;
166
+ console.error = origError;
167
+ await onShutdown?.();
84
168
  }
85
169
  }
86
170
  /**
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAQzD,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAwB,CAAC;AAC9D,MAAM,CAAC,MAAM,OAAO,GAAW,GAAG,CAAC,OAAO,CAAC;AAa3C,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE5E,gFAAgF;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAExF,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAG1D,gFAAgF;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAIzD;;GAEG;AACH,SAAS,eAAe,CAAC,kBAAsC;IAC7D,IAAI,UAAU,IAAI,kBAAkB,EAAE,CAAC;QACrC,sCAAsC;QACtC,OAAQ,kBAA+B,CAAC,QAAQ,CAAC;IACnD,CAAC;IACD,yBAAyB;IACzB,OAAO,kBAA8B,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CAAC,kBAAsC;IAC7D,IAAI,MAAM,IAAI,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,EAAE,CAAC;QACtE,sBAAsB;QACtB,OAAO,kBAA8B,CAAC;IACxC,CAAC;IACD,wDAAwD;IACxD,qEAAqE;IACrE,MAAM,IAAI,KAAK,CACb,4FAA4F;QAC1F,gDAAgD,CACnD,CAAC;AACJ,CAAC;AAoBD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,kBAAsC,EACtC,UAAwB,EAAE;IAE1B,MAAM,EACJ,SAAS,GAAG,OAAO,EACnB,IAAI,GAAG,WAAW,EAClB,IAAI,GAAG,IAAI,EACX,IAAI,GAAG,YAAY,EACnB,OAAO,GAAG,OAAO,GAClB,GAAG,OAAO,CAAC;IAEZ,MAAM,QAAQ,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;IAErD,8BAA8B;IAC9B,MAAM,OAAO,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;IAC7C,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAEhD,OAAO,CAAC,IAAI,CACV,wBAAwB,IAAI,MAAM,OAAO,SAAS,KAAK,CAAC,MAAM,cAAc,SAAS,EAAE,CACxF,CAAC;IAEF,2BAA2B;IAC3B,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAEhD,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;QAC1B,MAAM,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;SAAM,IAAI,SAAS,KAAK,iBAAiB,EAAE,CAAC;QAC3C,MAAM,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACnE,CAAC;SAAM,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;QAC/B,MAAM,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CACb,uBAAuB,SAAmB,mDAAmD,CAC9F,CAAC;IACJ,CAAC;AACH,CAAC;AAKD;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,kBAAsC,EACtC,UAAgC,EAAE;IAElC,MAAM,QAAQ,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,IAAI,eAAe,EAAE,CAAC;IACxC,MAAM,KAAK,GAAG,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3D,OAAO,KAAK,CAAC;AACf,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAQxD,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAwB,CAAC;AAC9D,MAAM,CAAC,MAAM,OAAO,GAAW,GAAG,CAAC,OAAO,CAAC;AAa3C,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE5E,gFAAgF;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAExF,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAG1D,gFAAgF;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAIzD;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,kBAAsC;IACpE,IAAI,UAAU,IAAI,kBAAkB,EAAE,CAAC;QACrC,sCAAsC;QACtC,OAAQ,kBAA+B,CAAC,QAAQ,CAAC;IACnD,CAAC;IACD,yBAAyB;IACzB,OAAO,kBAA8B,CAAC;AACxC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,kBAAsC;IACpE,IAAI,MAAM,IAAI,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,EAAE,CAAC;QACtE,sBAAsB;QACtB,OAAO,kBAA8B,CAAC;IACxC,CAAC;IACD,mDAAmD;IACnD,IAAI,CAAC;QACH,iEAAiE;QACjE,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;QACpC,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC;QAClE,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,IAAI,aAAa,CAAC,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAa,CAAC;QACzE,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,kDAAkD;IACpD,CAAC;IACD,MAAM,IAAI,KAAK,CACb,2GAA2G,CAC5G,CAAC;AACJ,CAAC;AAsCD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,kBAAsC,EACtC,UAAwB,EAAE;IAE1B,MAAM,EACJ,SAAS,GAAG,OAAO,EACnB,IAAI,GAAG,WAAW,EAClB,IAAI,GAAG,IAAI,EACX,IAAI,GAAG,YAAY,EACnB,OAAO,GAAG,OAAO,EACjB,cAAc,EACd,IAAI,EACJ,MAAM,EACN,QAAQ,EACR,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,QAAQ,GAAG,KAAK,EAChB,cAAc,GAAG,WAAW,EAC5B,YAAY,GAAG,KAAK,GACrB,GAAG,OAAO,CAAC;IAEZ,8CAA8C;IAC9C,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,QAAQ,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,mDAAmD;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC;IAChC,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAC9B,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAC9B,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC;IAEhC,8BAA8B;IAC9B,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,MAAM,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,QAAQ,GAAG,CAAC;YAAE,OAAO,CAAC,KAAK,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;QAC3C,IAAI,QAAQ,GAAG,CAAC;YAAE,OAAO,CAAC,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;QAC1C,IAAI,QAAQ,GAAG,CAAC;YAAE,OAAO,CAAC,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;QAC1C,IAAI,QAAQ,GAAG,CAAC;YAAE,OAAO,CAAC,KAAK,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,QAAQ,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;IAErD,8BAA8B;IAC9B,MAAM,OAAO,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,QAAQ,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;IACjE,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAChD,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAEnD,QAAQ,CACN,wBAAwB,IAAI,MAAM,OAAO,SAAS,KAAK,CAAC,MAAM,cAAc,SAAS,EAAE,CACxF,CAAC;IAEF,0BAA0B;IAC1B,MAAM,SAAS,EAAE,EAAE,CAAC;IAEpB,2BAA2B;IAC3B,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAChD,gBAAgB,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9C,IAAI,gBAAgB,EAAE,CAAC;QACrB,gBAAgB,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IACzD,CAAC;IAED,0CAA0C;IAC1C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IAC/C,IAAI,QAAQ,IAAI,CAAC,cAAc,KAAK,iBAAiB,IAAI,cAAc,KAAK,KAAK,CAAC,EAAE,CAAC;QACnF,MAAM,eAAe,GAAG,IAAI,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE;YACzD,YAAY;YACZ,MAAM,EAAE,cAAc;SACvB,CAAC,CAAC;QACH,gBAAgB,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;QACrD,QAAQ,CAAC,4BAA4B,cAAc,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,CAAC;QACH,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;YAC1B,MAAM,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC1C,CAAC;aAAM,IAAI,SAAS,KAAK,iBAAiB,EAAE,CAAC;YAC3C,MAAM,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACnE,CAAC;aAAM,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YAC/B,MAAM,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,uBAAuB,SAAmB,mDAAmD,CAC9F,CAAC;QACJ,CAAC;IACH,CAAC;YAAS,CAAC;QACT,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;QAC1B,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC;QACxB,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC;QACxB,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC;QAC1B,MAAM,UAAU,EAAE,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAKD;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,kBAAsC,EACtC,UAAgC,EAAE;IAElC,MAAM,QAAQ,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,IAAI,eAAe,EAAE,CAAC;IACxC,MAAM,KAAK,GAAG,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3D,OAAO,KAAK,CAAC;AACf,CAAC"}
package/dist/server/factory.d.ts CHANGED
@@ -44,6 +44,18 @@ export declare class MCPServerFactory {
44
44
  * Skips modules that return null definitions or throw errors (with console.warn).
45
45
  */
46
46
  buildTools(registry: Registry, options?: BuildToolsOptions): Tool[];
47
+ /**
48
+ * Register resources/list and resources/read handlers for modules with documentation.
49
+ *
50
+ * Iterates over registry.list(), gets each definition, and filters for
51
+ * descriptors that have a non-null `documentation` field. Registers:
52
+ * - resources/list: returns Resource objects with URI docs://{module_id}
53
+ * - resources/read: returns documentation text for the requested module
54
+ *
55
+ * @param server - The MCP Server to register handlers on
56
+ * @param registry - Registry to discover modules with documentation
57
+ */
58
+ registerResourceHandlers(server: Server, registry: Registry): void;
47
59
  /**
48
60
  * Register tools/list and tools/call request handlers on a Server instance.
49
61
  *
package/dist/server/factory.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/server/factory.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AAKnE,OAAO,KAAK,EACV,IAAI,EAGL,MAAM,oCAAoC,CAAC;AAI5C,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGnD,iEAAiE;AACjE,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IACnD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;;IAOrD;;;;;;OAMG;IACH,YAAY,CACV,IAAI,GAAE,MAAqB,EAC3B,OAAO,GAAE,MAAgB,GACxB,MAAM;IAOT;;;;;;;;OAQG;IACH,SAAS,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI;IA4C7C;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,IAAI,EAAE;IA2BnE;;;;;;OAMG;IACH,gBAAgB,CACd,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,IAAI,EAAE,EACb,MAAM,EAAE,eAAe,GACtB,IAAI;CA4CR"}
1
+ {"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/server/factory.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AAOnE,OAAO,KAAK,EACV,IAAI,EAIL,MAAM,oCAAoC,CAAC;AAI5C,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGnD,iEAAiE;AACjE,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IACnD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmB;;IAOrD;;;;;;OAMG;IACH,YAAY,CACV,IAAI,GAAE,MAAqB,EAC3B,OAAO,GAAE,MAAgB,GACxB,MAAM;IAOT;;;;;;;;OAQG;IACH,SAAS,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI;IA+C7C;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,IAAI,EAAE;IA2BnE;;;;;;;;;;OAUG;IACH,wBAAwB,CACtB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,GACjB,IAAI;IAsDP;;;;;;OAMG;IACH,gBAAgB,CACd,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,IAAI,EAAE,EACb,MAAM,EAAE,eAAe,GACtB,IAAI;CA0CR"}