skybridge 0.7.0 → 0.8.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 +173 -0
- package/dist/src/server/index.d.ts +2 -0
- package/dist/src/server/inferUtilityTypes.d.ts +48 -0
- package/dist/src/server/inferUtilityTypes.js +2 -0
- package/dist/src/server/inferUtilityTypes.js.map +1 -0
- package/dist/src/server/server.d.ts +31 -9
- package/dist/src/server/server.js +5 -0
- package/dist/src/server/server.js.map +1 -1
- package/dist/src/test/utils.d.ts +61 -0
- package/dist/src/test/utils.js +122 -1
- package/dist/src/test/utils.js.map +1 -1
- package/dist/src/web/generate-helpers.d.ts +115 -0
- package/dist/src/web/generate-helpers.js +109 -0
- package/dist/src/web/generate-helpers.js.map +1 -0
- package/dist/src/web/generate-helpers.test-d.d.ts +1 -0
- package/dist/src/web/generate-helpers.test-d.js +151 -0
- package/dist/src/web/generate-helpers.test-d.js.map +1 -0
- package/dist/src/web/generate-helpers.test.d.ts +1 -0
- package/dist/src/web/generate-helpers.test.js +17 -0
- package/dist/src/web/generate-helpers.test.js.map +1 -0
- package/dist/src/web/hooks/index.d.ts +1 -1
- package/dist/src/web/hooks/index.js +1 -1
- package/dist/src/web/hooks/index.js.map +1 -1
- package/dist/src/web/hooks/use-call-tool.d.ts +57 -19
- package/dist/src/web/hooks/use-call-tool.js +7 -15
- package/dist/src/web/hooks/use-call-tool.js.map +1 -1
- package/dist/src/web/hooks/use-call-tool.test-d.d.ts +1 -0
- package/dist/src/web/hooks/use-call-tool.test-d.js +104 -0
- package/dist/src/web/hooks/use-call-tool.test-d.js.map +1 -0
- package/dist/src/web/hooks/use-tool-info.d.ts +3 -3
- package/dist/src/web/index.d.ts +1 -0
- package/dist/src/web/index.js +1 -0
- package/dist/src/web/index.js.map +1 -1
- package/dist/src/web/types.d.ts +8 -0
- package/dist/src/web/types.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -97,6 +97,132 @@ export default defineConfig({
|
|
|
97
97
|
});
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
+
**Typed Hooks**
|
|
101
|
+
|
|
102
|
+
Skybridge provides fully typed hooks that give you autocomplete for tool names and type inference for inputs/outputs - similar to tRPC. This is opt-in and requires exporting your server type.
|
|
103
|
+
|
|
104
|
+
> **Tip:** For the best TypeScript experience, use typed hooks throughout your application. They provide autocomplete, type safety, and better IDE support.
|
|
105
|
+
|
|
106
|
+
> **Important:** For `generateHelpers` to work correctly, your MCP server must be defined using method chaining (e.g., `server.widget(...).widget(...).registerTool(...)`). This ensures TypeScript can properly infer the tool registry type from the chained calls.
|
|
107
|
+
|
|
108
|
+
**Examples:**
|
|
109
|
+
|
|
110
|
+
✅ **Works** - Using method chaining:
|
|
111
|
+
|
|
112
|
+
```ts
|
|
113
|
+
import { McpServer } from "skybridge/server";
|
|
114
|
+
import { z } from "zod";
|
|
115
|
+
|
|
116
|
+
const server = new McpServer({ name: "my-app", version: "1.0" }, {})
|
|
117
|
+
.widget("search-voyage", {}, {
|
|
118
|
+
inputSchema: { destination: z.string() },
|
|
119
|
+
}, async ({ destination }) => {
|
|
120
|
+
return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
|
|
121
|
+
})
|
|
122
|
+
.registerTool("calculate-price", {
|
|
123
|
+
inputSchema: { tripId: z.string() },
|
|
124
|
+
}, async ({ tripId }) => {
|
|
125
|
+
return { content: [{ type: "text", text: `Price for ${tripId}` }] };
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
export type AppType = typeof server; // ✅ Type inference works correctly
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
❌ **Doesn't work** - Without method chaining:
|
|
132
|
+
|
|
133
|
+
```ts
|
|
134
|
+
import { McpServer } from "skybridge/server";
|
|
135
|
+
import { z } from "zod";
|
|
136
|
+
|
|
137
|
+
const server = new McpServer({ name: "my-app", version: "1.0" }, {});
|
|
138
|
+
|
|
139
|
+
server.widget("search-voyage", {}, {
|
|
140
|
+
inputSchema: { destination: z.string() },
|
|
141
|
+
}, async ({ destination }) => {
|
|
142
|
+
return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
server.registerTool("calculate-price", {
|
|
146
|
+
inputSchema: { tripId: z.string() },
|
|
147
|
+
}, async ({ tripId }) => {
|
|
148
|
+
return { content: [{ type: "text", text: `Price for ${tripId}` }] };
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
export type AppType = typeof server; // ❌ Type inference fails - tool registry is empty
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
_Server setup (server/src/index.ts)_
|
|
155
|
+
|
|
156
|
+
```ts
|
|
157
|
+
import { McpServer } from "skybridge/server";
|
|
158
|
+
import { z } from "zod";
|
|
159
|
+
|
|
160
|
+
const server = new McpServer({ name: "my-app", version: "1.0" }, {})
|
|
161
|
+
.widget("search-voyage", {}, {
|
|
162
|
+
description: "Search for trips",
|
|
163
|
+
inputSchema: {
|
|
164
|
+
destination: z.string(),
|
|
165
|
+
departureDate: z.string().optional(),
|
|
166
|
+
},
|
|
167
|
+
outputSchema: {
|
|
168
|
+
results: z.array(z.object({ id: z.string(), name: z.string() })),
|
|
169
|
+
totalCount: z.number(),
|
|
170
|
+
},
|
|
171
|
+
}, async ({ destination }) => {
|
|
172
|
+
// Your tool logic here...
|
|
173
|
+
return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
|
|
174
|
+
})
|
|
175
|
+
.widget("get-details", {}, {
|
|
176
|
+
inputSchema: { tripId: z.string() },
|
|
177
|
+
}, async ({ tripId }) => {
|
|
178
|
+
return { content: [{ type: "text", text: `Details for ${tripId}` }] };
|
|
179
|
+
});
|
|
180
|
+
|
|
181
|
+
// Export the server type for the client
|
|
182
|
+
export type AppType = typeof server;
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
_One-time setup (web/src/skybridge.ts)_
|
|
186
|
+
|
|
187
|
+
Create typed hooks once and export them for use across your app. This file acts as a bridge between your server types and your widgets:
|
|
188
|
+
|
|
189
|
+
```ts
|
|
190
|
+
import type { AppType } from "../server"; // type-only import
|
|
191
|
+
import { generateHelpers } from "skybridge/web";
|
|
192
|
+
|
|
193
|
+
export const { useCallTool, useToolInfo } = generateHelpers<AppType>();
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
_Usage in widgets (web/src/widgets/search.tsx)_
|
|
197
|
+
|
|
198
|
+
```tsx
|
|
199
|
+
import { useCallTool, useToolInfo } from "../skybridge"; // import typed hooks
|
|
200
|
+
|
|
201
|
+
export function SearchWidget() {
|
|
202
|
+
const { callTool, data, isPending } = useCallTool("search-voyage");
|
|
203
|
+
// ^ autocomplete for tool names
|
|
204
|
+
const toolInfo = useToolInfo<"search-voyage">();
|
|
205
|
+
// ^ autocomplete for widget names
|
|
206
|
+
|
|
207
|
+
const handleSearch = () => {
|
|
208
|
+
callTool({ destination: "Spain" });
|
|
209
|
+
// ^ autocomplete for input fields
|
|
210
|
+
};
|
|
211
|
+
|
|
212
|
+
return (
|
|
213
|
+
<div>
|
|
214
|
+
<button onClick={handleSearch} disabled={isPending}>
|
|
215
|
+
Search
|
|
216
|
+
</button>
|
|
217
|
+
{toolInfo.isSuccess && (
|
|
218
|
+
<div>Found {toolInfo.output.structuredContent.totalCount} results</div>
|
|
219
|
+
// ^ typed output
|
|
220
|
+
)}
|
|
221
|
+
</div>
|
|
222
|
+
);
|
|
223
|
+
}
|
|
224
|
+
```
|
|
225
|
+
|
|
100
226
|
**Hooks**
|
|
101
227
|
|
|
102
228
|
The `skybridge/web` package comes with a set of hooks to help you build your widgets :
|
|
@@ -104,7 +230,9 @@ The `skybridge/web` package comes with a set of hooks to help you build your wid
|
|
|
104
230
|
- `useOpenAiGlobal`: A generic hook to get any global data from the OpenAI iFrame skybridge runtime (in `window.openai`).
|
|
105
231
|
- `useToolOutput`: A hook to get the initial tool `structuredContent` returned when rendering the widget for the first time. The data inside this hook is not updated when the tool is called again.
|
|
106
232
|
- `useToolResponseMetadata`: A hook to get the initial tool `meta` returned when rendering the widget for the first time. The data inside this hook is not updated when the tool is called again.
|
|
233
|
+
- `useToolInfo`: A hook to get the tool input, output, and response metadata with type inference. Provides a discriminated union based on status (pending/success).
|
|
107
234
|
- `useCallTool`: A @tanstack/react-query inspired hook to send make additional tool calls inside a widget.
|
|
235
|
+
- `generateHelpers`: A factory that creates typed versions of `useCallTool` and `useToolInfo` with full type inference from your server type.
|
|
108
236
|
|
|
109
237
|
_useOpenAiGlobal_
|
|
110
238
|
|
|
@@ -130,6 +258,51 @@ import { useToolResponseMetadata } from "skybridge/web";
|
|
|
130
258
|
const toolResponseMetadata = useToolResponseMetadata();
|
|
131
259
|
```
|
|
132
260
|
|
|
261
|
+
_useToolInfo_
|
|
262
|
+
|
|
263
|
+
```ts
|
|
264
|
+
import { useToolInfo } from "skybridge/web";
|
|
265
|
+
|
|
266
|
+
const toolInfo = useToolInfo<{
|
|
267
|
+
input: { query: string };
|
|
268
|
+
output: { results: string[] };
|
|
269
|
+
responseMetadata: { id: number };
|
|
270
|
+
}>();
|
|
271
|
+
|
|
272
|
+
// toolInfo.input is typed based on the input type
|
|
273
|
+
// toolInfo.output.structuredContent is typed based on the output type (undefined when pending)
|
|
274
|
+
// toolInfo.status narrows correctly: "pending" | "success"
|
|
275
|
+
|
|
276
|
+
if (toolInfo.isPending) {
|
|
277
|
+
// toolInfo.output is undefined here (pending state)
|
|
278
|
+
console.log(toolInfo.input.query);
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
if (toolInfo.isSuccess) {
|
|
282
|
+
// toolInfo.output.structuredContent is typed here
|
|
283
|
+
console.log(toolInfo.output.structuredContent.results);
|
|
284
|
+
}
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
_useToolInfo_ with typed hooks (recommended)
|
|
288
|
+
|
|
289
|
+
```tsx
|
|
290
|
+
import { useToolInfo } from "../skybridge"; // import typed hooks
|
|
291
|
+
|
|
292
|
+
export function SearchWidget() {
|
|
293
|
+
const toolInfo = useToolInfo<"search-voyage">();
|
|
294
|
+
// ^ autocomplete for widget names
|
|
295
|
+
// toolInfo.input is typed as { destination: string; departureDate?: string; ... }
|
|
296
|
+
// toolInfo.output.structuredContent is typed as { results: Array<...>; totalCount: number; }
|
|
297
|
+
|
|
298
|
+
if (toolInfo.isSuccess) {
|
|
299
|
+
return <div>Found {toolInfo.output.structuredContent.totalCount} results</div>;
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
return <div>Searching for {toolInfo.input.destination}...</div>;
|
|
303
|
+
}
|
|
304
|
+
```
|
|
305
|
+
|
|
133
306
|
_useCallTool_ in synchronous mode
|
|
134
307
|
|
|
135
308
|
```ts
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type { McpServer, ToolDef } from "./server.js";
|
|
2
|
+
/**
|
|
3
|
+
* Any tool registry shape (includes both widgets and regular tools).
|
|
4
|
+
* Used as a constraint for type parameters that accept tool registries.
|
|
5
|
+
*/
|
|
6
|
+
export type AnyToolRegistry = Record<string, ToolDef>;
|
|
7
|
+
/**
|
|
8
|
+
* Extract the tool registry type from an McpServer instance.
|
|
9
|
+
* This includes both widgets (registered via widget()) and regular tools (registered via registerTool()).
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* type MyTools = InferTools<MyServer>;
|
|
14
|
+
* // { "search": ToolDef<...>, "calculate": ToolDef<...> }
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
export type InferTools<ServerType> = ServerType extends McpServer<infer W> ? W : never;
|
|
18
|
+
type ExtractTool<ServerType, K extends ToolNames<ServerType>> = InferTools<ServerType>[K];
|
|
19
|
+
/**
|
|
20
|
+
* Get a union of all tool names from an McpServer instance.
|
|
21
|
+
* This includes both widgets and regular tools.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* type Names = ToolNames<MyServer>;
|
|
26
|
+
* // "search" | "calculate" | "details"
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
export type ToolNames<ServerType> = keyof InferTools<ServerType> & string;
|
|
30
|
+
/**
|
|
31
|
+
* Get the input type for a specific tool (widget or regular tool).
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```ts
|
|
35
|
+
* type SearchInput = ToolInput<MyServer, "search">;
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
export type ToolInput<ServerType, ToolName extends ToolNames<ServerType>> = ExtractTool<ServerType, ToolName>["input"];
|
|
39
|
+
/**
|
|
40
|
+
* Get the output type for a specific tool (widget or regular tool).
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* type SearchOutput = ToolOutput<MyServer, "search">;
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
export type ToolOutput<ServerType, ToolName extends ToolNames<ServerType>> = ExtractTool<ServerType, ToolName>["output"];
|
|
48
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"inferUtilityTypes.js","sourceRoot":"","sources":["../../../src/server/inferUtilityTypes.ts"],"names":[],"mappings":""}
|
|
@@ -1,13 +1,35 @@
|
|
|
1
|
-
import { McpServer as McpServerBase, type
|
|
2
|
-
import type { Resource } from "@modelcontextprotocol/sdk/types.js";
|
|
3
|
-
import type {
|
|
1
|
+
import { McpServer as McpServerBase, type RegisteredTool } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
2
|
+
import type { Resource, ToolAnnotations, CallToolResult, ServerRequest, ServerNotification } from "@modelcontextprotocol/sdk/types.js";
|
|
3
|
+
import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
|
|
4
|
+
import type { ZodRawShape, ZodObject, infer as Infer } from "zod";
|
|
5
|
+
export type ToolDef<TInput = unknown, TOutput = unknown> = {
|
|
6
|
+
input: TInput;
|
|
7
|
+
output: TOutput;
|
|
8
|
+
};
|
|
4
9
|
type McpServerOriginalResourceConfig = Omit<Resource, "uri" | "name" | "mimeType">;
|
|
5
|
-
type McpServerOriginalToolConfig = Omit<Parameters<
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
10
|
+
type McpServerOriginalToolConfig = Omit<Parameters<McpServerBase["registerTool"]>[1], "inputSchema" | "outputSchema">;
|
|
11
|
+
type ExtractStructuredContent<T> = T extends {
|
|
12
|
+
structuredContent: infer SC;
|
|
13
|
+
} ? SC : never;
|
|
14
|
+
type AddTool<TTools, TName extends string, TInput extends ZodRawShape, TOutput> = McpServer<TTools & {
|
|
15
|
+
[K in TName]: ToolDef<Infer<ZodObject<TInput>>, TOutput>;
|
|
16
|
+
}>;
|
|
17
|
+
type ToolConfig<TInput extends ZodRawShape> = {
|
|
18
|
+
title?: string;
|
|
19
|
+
description?: string;
|
|
20
|
+
inputSchema?: TInput;
|
|
21
|
+
outputSchema?: ZodRawShape;
|
|
22
|
+
annotations?: ToolAnnotations;
|
|
23
|
+
_meta?: Record<string, unknown>;
|
|
24
|
+
};
|
|
25
|
+
type ToolHandler<TInput extends ZodRawShape, TReturn extends CallToolResult = CallToolResult> = (args: Infer<ZodObject<TInput>>, extra: RequestHandlerExtra<ServerRequest, ServerNotification>) => TReturn | Promise<TReturn>;
|
|
26
|
+
export declare class McpServer<TTools extends Record<string, ToolDef> = {}> extends McpServerBase {
|
|
27
|
+
widget<TName extends string, TInput extends ZodRawShape, TReturn extends CallToolResult>(name: TName, resourceConfig: McpServerOriginalResourceConfig, toolConfig: McpServerOriginalToolConfig & {
|
|
28
|
+
inputSchema?: TInput;
|
|
29
|
+
outputSchema?: ZodRawShape;
|
|
30
|
+
}, toolCallback: ToolHandler<TInput, TReturn>): AddTool<TTools, TName, TInput, ExtractStructuredContent<TReturn>>;
|
|
31
|
+
registerTool<TName extends string, InputArgs extends ZodRawShape, TReturn extends CallToolResult>(name: TName, config: ToolConfig<InputArgs>, cb: ToolHandler<InputArgs, TReturn>): AddTool<TTools, TName, InputArgs, ExtractStructuredContent<TReturn>>;
|
|
32
|
+
registerTool<InputArgs extends ZodRawShape>(name: string, config: ToolConfig<InputArgs>, cb: ToolHandler<InputArgs>): RegisteredTool;
|
|
11
33
|
private lookupDistFile;
|
|
12
34
|
}
|
|
13
35
|
export {};
|
|
@@ -48,6 +48,11 @@ export class McpServer extends McpServerBase {
|
|
|
48
48
|
...toolConfig,
|
|
49
49
|
_meta: toolMeta,
|
|
50
50
|
}, toolCallback);
|
|
51
|
+
return this;
|
|
52
|
+
}
|
|
53
|
+
registerTool(name, config, cb) {
|
|
54
|
+
super.registerTool(name, config, cb);
|
|
55
|
+
return this;
|
|
51
56
|
}
|
|
52
57
|
lookupDistFile(key) {
|
|
53
58
|
const manifest = JSON.parse(readFileSync(path.join(process.cwd(), "dist", "assets", ".vite", "manifest.json"), "utf-8"));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/server/server.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,IAAI,aAAa,
|
|
1
|
+
{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/server/server.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,IAAI,aAAa,GAG3B,MAAM,yCAAyC,CAAC;AAUjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAqF7B,MAAM,OAAO,SAEX,SAAQ,aAAa;IACrB,MAAM,CAKJ,IAAW,EACX,cAA+C,EAC/C,UAGC,EACD,YAA0C;QAE1C,MAAM,GAAG,GAAG,gBAAgB,IAAI,OAAO,CAAC;QACxC,MAAM,gBAAgB,GAAiB;YACrC,GAAG,CAAC,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;SAChC,CAAC;QACF,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACzC,gBAAgB,CAAC,0BAA0B,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC;QACxE,CAAC;QAED,IAAI,CAAC,QAAQ,CACX,IAAI,EACJ,GAAG,EACH;YACE,GAAG,cAAc;YACjB,KAAK,EAAE,gBAAgB;SACxB,EACD,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;YACpB,MAAM,SAAS,GACb,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;gBACnC,CAAC,CAAC,WACE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,kBAAkB,CAAC;oBACjD,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,IAC/B,EAAE;gBACJ,CAAC,CAAC,uBAAuB,CAAC;YAE9B,MAAM,IAAI,GACR,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;gBACnC,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC;oBAC9B,SAAS;oBACT,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,eAAe,IAAI,MAAM,CAAC;oBAC1D,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;iBAC5C,CAAC;gBACJ,CAAC,CAAC,cAAc,CAAC,iBAAiB,CAAC;oBAC/B,SAAS;oBACT,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;YAET,OAAO;gBACL,QAAQ,EAAE;oBACR;wBACE,GAAG;wBACH,QAAQ,EAAE,qBAAqB;wBAC/B,IAAI,EAAE,IAAI;qBACX;iBACF;aACF,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,MAAM,QAAQ,GAAa;YACzB,GAAG,UAAU,CAAC,KAAK;YACnB,uBAAuB,EAAE,GAAG;YAC5B,gBAAgB,EAAE,GAAG;SACtB,CAAC;QAEF,IAAI,CAAC,YAAY,CACf,IAAI,EACJ;YACE,GAAG,UAAU;YACb,KAAK,EAAE,QAAQ;SAChB,EACD,YAAY,CACb,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;IAkBQ,YAAY,CACnB,IAAY,EACZ,MAA6B,EAC7B,EAA2B;QAE3B,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,cAAc,CAAC,GAAW;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CACzB,YAAY,CACV,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,CAAC,EACpE,OAAO,CACR,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;IAC7B,CAAC;CACF"}
|
package/dist/src/test/utils.d.ts
CHANGED
|
@@ -8,6 +8,67 @@ export declare function createMockMcpServer(): {
|
|
|
8
8
|
mockResource: MockInstance<McpServer["resource"]>;
|
|
9
9
|
mockRegisterTool: MockInstance<McpServer["registerTool"]>;
|
|
10
10
|
};
|
|
11
|
+
export declare function createTestServer(): McpServer<{
|
|
12
|
+
"search-voyage": import("../server/server.js").ToolDef<{
|
|
13
|
+
destination: string;
|
|
14
|
+
departureDate?: string | undefined;
|
|
15
|
+
maxPrice?: number | undefined;
|
|
16
|
+
}, {
|
|
17
|
+
results: {
|
|
18
|
+
id: string;
|
|
19
|
+
name: string;
|
|
20
|
+
price: number;
|
|
21
|
+
}[];
|
|
22
|
+
totalCount: number;
|
|
23
|
+
}>;
|
|
24
|
+
} & {
|
|
25
|
+
"get-trip-details": import("../server/server.js").ToolDef<{
|
|
26
|
+
tripId: string;
|
|
27
|
+
}, {
|
|
28
|
+
name: string;
|
|
29
|
+
description: string;
|
|
30
|
+
images: string[];
|
|
31
|
+
}>;
|
|
32
|
+
} & {
|
|
33
|
+
"no-input-widget": import("../server/server.js").ToolDef<{}, {}>;
|
|
34
|
+
} & {
|
|
35
|
+
"inferred-output-widget": import("../server/server.js").ToolDef<{
|
|
36
|
+
query: string;
|
|
37
|
+
}, {
|
|
38
|
+
inferredResults: {
|
|
39
|
+
id: string;
|
|
40
|
+
score: number;
|
|
41
|
+
}[];
|
|
42
|
+
inferredCount: number;
|
|
43
|
+
}>;
|
|
44
|
+
} & {
|
|
45
|
+
"calculate-price": import("../server/server.js").ToolDef<{
|
|
46
|
+
tripId: string;
|
|
47
|
+
passengers: number;
|
|
48
|
+
}, {
|
|
49
|
+
totalPrice: number;
|
|
50
|
+
currency: string;
|
|
51
|
+
}>;
|
|
52
|
+
} & {
|
|
53
|
+
"inferred-tool": import("../server/server.js").ToolDef<{
|
|
54
|
+
itemId: string;
|
|
55
|
+
}, {
|
|
56
|
+
itemDetails: {
|
|
57
|
+
name: string;
|
|
58
|
+
available: boolean;
|
|
59
|
+
};
|
|
60
|
+
fetchedAt: string;
|
|
61
|
+
}>;
|
|
62
|
+
}>;
|
|
63
|
+
export declare function createMinimalTestServer(): McpServer<{
|
|
64
|
+
"search-voyage": import("../server/server.js").ToolDef<{
|
|
65
|
+
destination: string;
|
|
66
|
+
}, {
|
|
67
|
+
results: {
|
|
68
|
+
id: string;
|
|
69
|
+
}[];
|
|
70
|
+
}>;
|
|
71
|
+
}>;
|
|
11
72
|
/**
|
|
12
73
|
* Mock extra parameter for resource callback
|
|
13
74
|
*/
|
package/dist/src/test/utils.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { vi } from "vitest";
|
|
2
|
-
import { McpServer
|
|
2
|
+
import { McpServer } from "../server/server.js";
|
|
3
|
+
import { z } from "zod";
|
|
3
4
|
/**
|
|
4
5
|
* Creates a real McpServer instance for testing
|
|
5
6
|
*/
|
|
@@ -18,6 +19,126 @@ export function createMockMcpServer() {
|
|
|
18
19
|
mockRegisterTool,
|
|
19
20
|
};
|
|
20
21
|
}
|
|
22
|
+
export function createTestServer() {
|
|
23
|
+
return new McpServer({ name: "test-app", version: "1.0.0" }, {})
|
|
24
|
+
.widget("search-voyage", {}, {
|
|
25
|
+
description: "Search for voyages",
|
|
26
|
+
inputSchema: {
|
|
27
|
+
destination: z.string(),
|
|
28
|
+
departureDate: z.string().optional(),
|
|
29
|
+
maxPrice: z.number().optional(),
|
|
30
|
+
},
|
|
31
|
+
outputSchema: {
|
|
32
|
+
results: z.array(z.object({
|
|
33
|
+
id: z.string(),
|
|
34
|
+
name: z.string(),
|
|
35
|
+
price: z.number(),
|
|
36
|
+
})),
|
|
37
|
+
totalCount: z.number(),
|
|
38
|
+
},
|
|
39
|
+
}, async ({ destination }) => {
|
|
40
|
+
return {
|
|
41
|
+
content: [{ type: "text", text: `Found trips to ${destination}` }],
|
|
42
|
+
structuredContent: {
|
|
43
|
+
results: [{ id: "1", name: "Trip", price: 1000 }],
|
|
44
|
+
totalCount: 1,
|
|
45
|
+
},
|
|
46
|
+
};
|
|
47
|
+
})
|
|
48
|
+
.widget("get-trip-details", {}, {
|
|
49
|
+
description: "Get trip details",
|
|
50
|
+
inputSchema: {
|
|
51
|
+
tripId: z.string(),
|
|
52
|
+
},
|
|
53
|
+
outputSchema: {
|
|
54
|
+
name: z.string(),
|
|
55
|
+
description: z.string(),
|
|
56
|
+
images: z.array(z.string()),
|
|
57
|
+
},
|
|
58
|
+
}, async ({ tripId }) => {
|
|
59
|
+
return {
|
|
60
|
+
content: [{ type: "text", text: `Details for ${tripId}` }],
|
|
61
|
+
structuredContent: {
|
|
62
|
+
name: "Trip",
|
|
63
|
+
description: "A great trip",
|
|
64
|
+
images: ["image1.jpg"],
|
|
65
|
+
},
|
|
66
|
+
};
|
|
67
|
+
})
|
|
68
|
+
.widget("no-input-widget", {}, {
|
|
69
|
+
description: "Widget with no input",
|
|
70
|
+
inputSchema: {},
|
|
71
|
+
outputSchema: {},
|
|
72
|
+
}, async () => {
|
|
73
|
+
return {
|
|
74
|
+
content: [{ type: "text", text: "No input needed" }],
|
|
75
|
+
structuredContent: {},
|
|
76
|
+
};
|
|
77
|
+
})
|
|
78
|
+
.widget("inferred-output-widget", {}, {
|
|
79
|
+
description: "Widget with output inferred from callback",
|
|
80
|
+
inputSchema: {
|
|
81
|
+
query: z.string(),
|
|
82
|
+
},
|
|
83
|
+
}, async ({ query }) => {
|
|
84
|
+
return {
|
|
85
|
+
content: [{ type: "text", text: `Query: ${query}` }],
|
|
86
|
+
structuredContent: {
|
|
87
|
+
inferredResults: [{ id: "inferred-1", score: 0.95 }],
|
|
88
|
+
inferredCount: 1,
|
|
89
|
+
},
|
|
90
|
+
};
|
|
91
|
+
})
|
|
92
|
+
.registerTool("calculate-price", {
|
|
93
|
+
description: "Calculate trip price",
|
|
94
|
+
inputSchema: {
|
|
95
|
+
tripId: z.string(),
|
|
96
|
+
passengers: z.number(),
|
|
97
|
+
},
|
|
98
|
+
outputSchema: {
|
|
99
|
+
totalPrice: z.number(),
|
|
100
|
+
currency: z.string(),
|
|
101
|
+
},
|
|
102
|
+
}, async ({ tripId, passengers }) => {
|
|
103
|
+
return {
|
|
104
|
+
content: [{ type: "text", text: `Price for ${tripId}` }],
|
|
105
|
+
structuredContent: {
|
|
106
|
+
totalPrice: 1000 * passengers,
|
|
107
|
+
currency: "USD",
|
|
108
|
+
},
|
|
109
|
+
};
|
|
110
|
+
})
|
|
111
|
+
.registerTool("inferred-tool", {
|
|
112
|
+
description: "Tool with output inferred from callback",
|
|
113
|
+
inputSchema: {
|
|
114
|
+
itemId: z.string(),
|
|
115
|
+
},
|
|
116
|
+
}, async ({ itemId }) => {
|
|
117
|
+
return {
|
|
118
|
+
content: [{ type: "text", text: `Item: ${itemId}` }],
|
|
119
|
+
structuredContent: {
|
|
120
|
+
itemDetails: { name: "Inferred Item", available: true },
|
|
121
|
+
fetchedAt: "2024-01-01",
|
|
122
|
+
},
|
|
123
|
+
};
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
export function createMinimalTestServer() {
|
|
127
|
+
return new McpServer({ name: "test-app", version: "1.0.0" }, {}).widget("search-voyage", {}, {
|
|
128
|
+
description: "Search for voyages",
|
|
129
|
+
inputSchema: {
|
|
130
|
+
destination: z.string(),
|
|
131
|
+
},
|
|
132
|
+
outputSchema: {
|
|
133
|
+
results: z.array(z.object({ id: z.string() })),
|
|
134
|
+
},
|
|
135
|
+
}, async ({ destination }) => {
|
|
136
|
+
return {
|
|
137
|
+
content: [{ type: "text", text: `Found trips to ${destination}` }],
|
|
138
|
+
structuredContent: { results: [{ id: "1" }] },
|
|
139
|
+
};
|
|
140
|
+
});
|
|
141
|
+
}
|
|
21
142
|
/**
|
|
22
143
|
* Mock extra parameter for resource callback
|
|
23
144
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/test/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAqB,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/test/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAqB,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,UAAU,mBAAmB;IAKjC,mCAAmC;IACnC,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B;QACE,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,OAAO;KACjB,EACD,EAAE,YAAY,EAAE,EAAE,EAAE,CACrB,CAAC;IAEF,6CAA6C;IAC7C,MAAM,YAAY,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClD,MAAM,gBAAgB,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAE1D,OAAO;QACL,MAAM;QACN,YAAY;QACZ,gBAAgB;KACjB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,OAAO,IAAI,SAAS,CAClB,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,EACtC,EAAE,CACH;SACE,MAAM,CACL,eAAe,EACf,EAAE,EACF;QACE,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE;YACX,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;YACvB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACpC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAChC;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,CAAC,CAAC,KAAK,CACd,CAAC,CAAC,MAAM,CAAC;gBACP,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;gBACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;gBAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;aAClB,CAAC,CACH;YACD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;SACvB;KACF,EACD,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;QACxB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,WAAW,EAAE,EAAE,CAAC;YAClE,iBAAiB,EAAE;gBACjB,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;gBACjD,UAAU,EAAE,CAAC;aACd;SACF,CAAC;IACJ,CAAC,CACF;SACA,MAAM,CACL,kBAAkB,EAClB,EAAE,EACF;QACE,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE;YACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;SACnB;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;YAChB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;YACvB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SAC5B;KACF,EACD,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QACnB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,MAAM,EAAE,EAAE,CAAC;YAC1D,iBAAiB,EAAE;gBACjB,IAAI,EAAE,MAAM;gBACZ,WAAW,EAAE,cAAc;gBAC3B,MAAM,EAAE,CAAC,YAAY,CAAC;aACvB;SACF,CAAC;IACJ,CAAC,CACF;SACA,MAAM,CACL,iBAAiB,EACjB,EAAE,EACF;QACE,WAAW,EAAE,sBAAsB;QACnC,WAAW,EAAE,EAAE;QACf,YAAY,EAAE,EAAE;KACjB,EACD,KAAK,IAAI,EAAE;QACT,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;YACpD,iBAAiB,EAAE,EAAE;SACtB,CAAC;IACJ,CAAC,CACF;SACA,MAAM,CACL,wBAAwB,EACxB,EAAE,EACF;QACE,WAAW,EAAE,2CAA2C;QACxD,WAAW,EAAE;YACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;SAClB;KACF,EACD,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QAClB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,EAAE,EAAE,CAAC;YACpD,iBAAiB,EAAE;gBACjB,eAAe,EAAE,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;gBACpD,aAAa,EAAE,CAAC;aACjB;SACF,CAAC;IACJ,CAAC,CACF;SACA,YAAY,CACX,iBAAiB,EACjB;QACE,WAAW,EAAE,sBAAsB;QACnC,WAAW,EAAE;YACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;YAClB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;SACvB;QACD,YAAY,EAAE;YACZ,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;YACtB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;SACrB;KACF,EACD,KAAK,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE;QAC/B,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,MAAM,EAAE,EAAE,CAAC;YACxD,iBAAiB,EAAE;gBACjB,UAAU,EAAE,IAAI,GAAG,UAAU;gBAC7B,QAAQ,EAAE,KAAK;aAChB;SACF,CAAC;IACJ,CAAC,CACF;SACA,YAAY,CACX,eAAe,EACf;QACE,WAAW,EAAE,yCAAyC;QACtD,WAAW,EAAE;YACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;SACnB;KACF,EACD,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QACnB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,EAAE,CAAC;YACpD,iBAAiB,EAAE;gBACjB,WAAW,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,SAAS,EAAE,IAAI,EAAE;gBACvD,SAAS,EAAE,YAAY;aACxB;SACF,CAAC;IACJ,CAAC,CACF,CAAC;AACN,CAAC;AAED,MAAM,UAAU,uBAAuB;IACrC,OAAO,IAAI,SAAS,CAClB,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,EACtC,EAAE,CACH,CAAC,MAAM,CACN,eAAe,EACf,EAAE,EACF;QACE,WAAW,EAAE,oBAAoB;QACjC,WAAW,EAAE;YACX,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;SACxB;QACD,YAAY,EAAE;YACZ,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;SAC/C;KACF,EACD,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;QACxB,OAAO;YACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,WAAW,EAAE,EAAE,CAAC;YAClE,iBAAiB,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE;SAC9C,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO;QACL,WAAW,EAAE;YACX,OAAO,EAAE,EAAE,IAAI,EAAE;SAClB;KACF,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAA2B;IACpD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY;IAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC9B,CAAC"}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { type CallToolState, type CallToolFn, type CallToolAsyncFn } from "./hooks/use-call-tool.js";
|
|
2
|
+
import { type ToolState } from "./hooks/use-tool-info.js";
|
|
3
|
+
import type { InferTools, ToolInput, ToolOutput } from "../server/index.js";
|
|
4
|
+
import type { CallToolResponse, Prettify, Objectify } from "./types.js";
|
|
5
|
+
type TypedCallToolResponse<TOutput> = CallToolResponse & {
|
|
6
|
+
structuredContent: TOutput;
|
|
7
|
+
};
|
|
8
|
+
type TypedCallToolReturn<TInput, TOutput> = Prettify<CallToolState<TypedCallToolResponse<TOutput>> & {
|
|
9
|
+
callTool: CallToolFn<TInput, TypedCallToolResponse<TOutput>>;
|
|
10
|
+
callToolAsync: CallToolAsyncFn<TInput, TypedCallToolResponse<TOutput>>;
|
|
11
|
+
}>;
|
|
12
|
+
type TypedToolInfoReturn<TInput, TOutput> = ToolState<Objectify<TInput>, {
|
|
13
|
+
structuredContent: TOutput;
|
|
14
|
+
}, Objectify<{}>>;
|
|
15
|
+
/**
|
|
16
|
+
* Creates typed versions of skybridge hooks with full type inference
|
|
17
|
+
* for tool names, inputs, and outputs.
|
|
18
|
+
*
|
|
19
|
+
* This is the recommended way to use skybridge hooks in your widgets.
|
|
20
|
+
* Set this up once in a dedicated file and export the typed hooks for use across your app.
|
|
21
|
+
*
|
|
22
|
+
* @typeParam ServerType - The type of your McpServer instance (use `typeof server`).
|
|
23
|
+
* Must be a server instance created with method chaining.
|
|
24
|
+
* TypeScript will validate that tools can be inferred from this type.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```typescript
|
|
28
|
+
* // server/src/index.ts
|
|
29
|
+
* const server = new McpServer({ name: "my-app", version: "1.0" }, {})
|
|
30
|
+
* .widget("search-voyage", {}, {
|
|
31
|
+
* inputSchema: { destination: z.string() },
|
|
32
|
+
* outputSchema: { results: z.array(z.string()) },
|
|
33
|
+
* }, async ({ destination }) => {
|
|
34
|
+
* return { content: [{ type: "text", text: `Found trips to ${destination}` }] };
|
|
35
|
+
* });
|
|
36
|
+
*
|
|
37
|
+
* export type AppType = typeof server;
|
|
38
|
+
* ```
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```typescript
|
|
42
|
+
* // web/src/skybridge.ts (one-time setup)
|
|
43
|
+
* import type { AppType } from "../server";
|
|
44
|
+
* import { generateHelpers } from "skybridge/web";
|
|
45
|
+
*
|
|
46
|
+
* export const { useCallTool, useToolInfo } = generateHelpers<AppType>();
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```typescript
|
|
51
|
+
* // web/src/widgets/search.tsx (usage)
|
|
52
|
+
* import { useCallTool, useToolInfo } from "../skybridge";
|
|
53
|
+
*
|
|
54
|
+
* export function SearchWidget() {
|
|
55
|
+
* const { callTool, data } = useCallTool("search-voyage");
|
|
56
|
+
* // ^ autocomplete for tool names
|
|
57
|
+
* callTool({ destination: "Spain" });
|
|
58
|
+
* // ^ autocomplete for input fields
|
|
59
|
+
*
|
|
60
|
+
* const toolInfo = useToolInfo<"search-voyage">();
|
|
61
|
+
* // ^ autocomplete for widget names
|
|
62
|
+
* // toolInfo.input is typed based on widget input schema
|
|
63
|
+
* // toolInfo.output.structuredContent is typed based on widget output schema
|
|
64
|
+
* }
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
export declare function generateHelpers<ServerType = never>(): {
|
|
68
|
+
/**
|
|
69
|
+
* Typed version of `useCallTool` that provides autocomplete for tool names
|
|
70
|
+
* and type inference for inputs and outputs.
|
|
71
|
+
*
|
|
72
|
+
* @param name - The name of the widget to call. Autocompletes based on your server's widget registry.
|
|
73
|
+
* @returns A hook with typed `callTool` function and `data` property.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```typescript
|
|
77
|
+
* const { callTool, data, isPending } = useCallTool("search-voyage");
|
|
78
|
+
* // TypeScript knows callTool expects { destination: string }
|
|
79
|
+
* callTool({ destination: "Spain" });
|
|
80
|
+
*
|
|
81
|
+
* // data.structuredContent is typed based on your outputSchema
|
|
82
|
+
* if (data) {
|
|
83
|
+
* console.log(data.structuredContent.results);
|
|
84
|
+
* }
|
|
85
|
+
* ```
|
|
86
|
+
*/
|
|
87
|
+
useCallTool: <ToolName extends keyof InferTools<ServerType> & string>(name: ToolName) => TypedCallToolReturn<ToolInput<ServerType, ToolName>, ToolOutput<ServerType, ToolName>>;
|
|
88
|
+
/**
|
|
89
|
+
* Typed version of `useToolInfo` that provides autocomplete for widget names
|
|
90
|
+
* and type inference for inputs, outputs, and responseMetadata.
|
|
91
|
+
*
|
|
92
|
+
* @typeParam K - The name of the widget. Autocompletes based on your server's widget registry.
|
|
93
|
+
* @returns A discriminated union with `status: "pending" | "success"` that narrows correctly.
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* ```typescript
|
|
97
|
+
* const toolInfo = useToolInfo<"search-voyage">();
|
|
98
|
+
* // toolInfo.input is typed as { destination: string; ... }
|
|
99
|
+
* // toolInfo.output.structuredContent is typed as { results: Array<...>; ... }
|
|
100
|
+
* // toolInfo.status narrows correctly: "pending" | "success"
|
|
101
|
+
*
|
|
102
|
+
* if (toolInfo.isPending) {
|
|
103
|
+
* // TypeScript knows output is undefined here
|
|
104
|
+
* console.log(toolInfo.input.destination);
|
|
105
|
+
* }
|
|
106
|
+
*
|
|
107
|
+
* if (toolInfo.isSuccess) {
|
|
108
|
+
* // TypeScript knows output is defined here
|
|
109
|
+
* console.log(toolInfo.output.structuredContent.results);
|
|
110
|
+
* }
|
|
111
|
+
* ```
|
|
112
|
+
*/
|
|
113
|
+
useToolInfo: <ToolName extends keyof InferTools<ServerType> & string>() => TypedToolInfoReturn<ToolInput<ServerType, ToolName>, ToolOutput<ServerType, ToolName>>;
|
|
114
|
+
};
|
|
115
|
+
export {};
|