mcp-use 1.1.6-canary.1 → 1.1.7-canary.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.
@@ -0,0 +1,124 @@
1
+ /**
2
+ * Type definitions for OpenAI Apps SDK window.openai API
3
+ * Based on: https://developers.openai.com/apps-sdk/build/custom-ux
4
+ */
5
+ export type UnknownObject = Record<string, unknown>;
6
+ export type Theme = 'light' | 'dark';
7
+ export type DisplayMode = 'pip' | 'inline' | 'fullscreen';
8
+ export type DeviceType = 'mobile' | 'tablet' | 'desktop' | 'unknown';
9
+ export type SafeAreaInsets = {
10
+ top: number;
11
+ bottom: number;
12
+ left: number;
13
+ right: number;
14
+ };
15
+ export type SafeArea = {
16
+ insets: SafeAreaInsets;
17
+ };
18
+ export type UserAgent = {
19
+ device: {
20
+ type: DeviceType;
21
+ };
22
+ capabilities: {
23
+ hover: boolean;
24
+ touch: boolean;
25
+ };
26
+ };
27
+ export type CallToolResponse = {
28
+ content: Array<{
29
+ type: string;
30
+ text?: string;
31
+ [key: string]: any;
32
+ }>;
33
+ isError?: boolean;
34
+ };
35
+ export interface OpenAiGlobals<ToolInput extends UnknownObject = UnknownObject, ToolOutput extends UnknownObject = UnknownObject, ToolResponseMetadata extends UnknownObject = UnknownObject, WidgetState extends UnknownObject = UnknownObject> {
36
+ theme: Theme;
37
+ userAgent: UserAgent;
38
+ locale: string;
39
+ maxHeight: number;
40
+ displayMode: DisplayMode;
41
+ safeArea: SafeArea;
42
+ toolInput: ToolInput;
43
+ toolOutput: ToolOutput | null;
44
+ toolResponseMetadata: ToolResponseMetadata | null;
45
+ widgetState: WidgetState | null;
46
+ }
47
+ export interface API<WidgetState extends UnknownObject = UnknownObject> {
48
+ /** Calls a tool on your MCP. Returns the full response. */
49
+ callTool: (name: string, args: Record<string, unknown>) => Promise<CallToolResponse>;
50
+ /** Triggers a followup turn in the ChatGPT conversation */
51
+ sendFollowUpMessage: (args: {
52
+ prompt: string;
53
+ }) => Promise<void>;
54
+ /** Opens an external link, redirects web page or mobile app */
55
+ openExternal(payload: {
56
+ href: string;
57
+ }): void;
58
+ /** For transitioning an app from inline to fullscreen or pip */
59
+ requestDisplayMode: (args: {
60
+ mode: DisplayMode;
61
+ }) => Promise<{
62
+ /**
63
+ * The granted display mode. The host may reject the request.
64
+ * For mobile, PiP is always coerced to fullscreen.
65
+ */
66
+ mode: DisplayMode;
67
+ }>;
68
+ /** Persist widget state that will be shown to the model */
69
+ setWidgetState: (state: WidgetState) => Promise<void>;
70
+ }
71
+ export declare const SET_GLOBALS_EVENT_TYPE = "openai:set_globals";
72
+ export declare class SetGlobalsEvent extends CustomEvent<{
73
+ globals: Partial<OpenAiGlobals>;
74
+ }> {
75
+ readonly type = "openai:set_globals";
76
+ }
77
+ declare global {
78
+ interface Window {
79
+ openai?: API<any> & OpenAiGlobals<any, any, any, any>;
80
+ }
81
+ interface WindowEventMap {
82
+ [SET_GLOBALS_EVENT_TYPE]: SetGlobalsEvent;
83
+ }
84
+ }
85
+ /**
86
+ * Result type for the useWidget hook
87
+ */
88
+ export interface UseWidgetResult<TProps extends UnknownObject = UnknownObject, TOutput extends UnknownObject = UnknownObject, TMetadata extends UnknownObject = UnknownObject, TState extends UnknownObject = UnknownObject> {
89
+ /** Widget props (mapped from toolInput for MCP compatibility) */
90
+ props: TProps;
91
+ /** Tool output from the last execution */
92
+ output: TOutput | null;
93
+ /** Response metadata from the tool */
94
+ metadata: TMetadata | null;
95
+ /** Persisted widget state */
96
+ state: TState | null;
97
+ /** Update widget state (persisted and shown to model) */
98
+ setState: (state: TState | ((prevState: TState | null) => TState)) => Promise<void>;
99
+ /** Current theme (light/dark) */
100
+ theme: Theme;
101
+ /** Current display mode */
102
+ displayMode: DisplayMode;
103
+ /** Safe area insets for layout */
104
+ safeArea: SafeArea;
105
+ /** Maximum height available */
106
+ maxHeight: number;
107
+ /** User agent information */
108
+ userAgent: UserAgent;
109
+ /** Current locale */
110
+ locale: string;
111
+ /** Call a tool on the MCP server */
112
+ callTool: (name: string, args: Record<string, unknown>) => Promise<CallToolResponse>;
113
+ /** Send a follow-up message to the conversation */
114
+ sendFollowUpMessage: (prompt: string) => Promise<void>;
115
+ /** Open an external URL */
116
+ openExternal: (href: string) => void;
117
+ /** Request a different display mode */
118
+ requestDisplayMode: (mode: DisplayMode) => Promise<{
119
+ mode: DisplayMode;
120
+ }>;
121
+ /** Whether the widget API is available */
122
+ isAvailable: boolean;
123
+ }
124
+ //# sourceMappingURL=widget-types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"widget-types.d.ts","sourceRoot":"","sources":["../../../src/react/widget-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEnD,MAAM,MAAM,KAAK,GAAG,OAAO,GAAG,MAAM,CAAA;AAEpC,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,QAAQ,GAAG,YAAY,CAAA;AAEzD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAA;AAEpE,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,MAAM,EAAE,cAAc,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,MAAM,EAAE;QAAE,IAAI,EAAE,UAAU,CAAA;KAAE,CAAA;IAC5B,YAAY,EAAE;QACZ,KAAK,EAAE,OAAO,CAAA;QACd,KAAK,EAAE,OAAO,CAAA;KACf,CAAA;CACF,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACnB,CAAC,CAAA;IACF,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,WAAW,aAAa,CAC5B,SAAS,SAAS,aAAa,GAAG,aAAa,EAC/C,UAAU,SAAS,aAAa,GAAG,aAAa,EAChD,oBAAoB,SAAS,aAAa,GAAG,aAAa,EAC1D,WAAW,SAAS,aAAa,GAAG,aAAa;IAEjD,KAAK,EAAE,KAAK,CAAA;IACZ,SAAS,EAAE,SAAS,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IAGd,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,WAAW,CAAA;IACxB,QAAQ,EAAE,QAAQ,CAAA;IAGlB,SAAS,EAAE,SAAS,CAAA;IACpB,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;IAC7B,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAA;IACjD,WAAW,EAAE,WAAW,GAAG,IAAI,CAAA;CAChC;AAED,MAAM,WAAW,GAAG,CAAC,WAAW,SAAS,aAAa,GAAG,aAAa;IACpE,2DAA2D;IAC3D,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE9B,2DAA2D;IAC3D,mBAAmB,EAAE,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhE,+DAA+D;IAC/D,YAAY,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAA;IAE7C,gEAAgE;IAChE,kBAAkB,EAAE,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,WAAW,CAAA;KAAE,KAAK,OAAO,CAAC;QAC3D;;;WAGG;QACH,IAAI,EAAE,WAAW,CAAA;KAClB,CAAC,CAAA;IAEF,2DAA2D;IAC3D,cAAc,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACtD;AAGD,eAAO,MAAM,sBAAsB,uBAAuB,CAAA;AAE1D,qBAAa,eAAgB,SAAQ,WAAW,CAAC;IAC/C,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;CAChC,CAAC;IACA,QAAQ,CAAC,IAAI,wBAAyB;CACvC;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;KACtD;IAED,UAAU,cAAc;QACtB,CAAC,sBAAsB,CAAC,EAAE,eAAe,CAAA;KAC1C;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAC9B,MAAM,SAAS,aAAa,GAAG,aAAa,EAC5C,OAAO,SAAS,aAAa,GAAG,aAAa,EAC7C,SAAS,SAAS,aAAa,GAAG,aAAa,EAC/C,MAAM,SAAS,aAAa,GAAG,aAAa;IAG5C,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAA;IACb,0CAA0C;IAC1C,MAAM,EAAE,OAAO,GAAG,IAAI,CAAA;IACtB,sCAAsC;IACtC,QAAQ,EAAE,SAAS,GAAG,IAAI,CAAA;IAC1B,6BAA6B;IAC7B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,yDAAyD;IACzD,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAGnF,iCAAiC;IACjC,KAAK,EAAE,KAAK,CAAA;IACZ,2BAA2B;IAC3B,WAAW,EAAE,WAAW,CAAA;IACxB,kCAAkC;IAClC,QAAQ,EAAE,QAAQ,CAAA;IAClB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,6BAA6B;IAC7B,SAAS,EAAE,SAAS,CAAA;IACpB,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAA;IAGd,oCAAoC;IACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAA;IACpF,mDAAmD;IACnD,mBAAmB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACtD,2BAA2B;IAC3B,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IACpC,uCAAuC;IACvC,kBAAkB,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,WAAW,CAAA;KAAE,CAAC,CAAA;IAEzE,0CAA0C;IAC1C,WAAW,EAAE,OAAO,CAAA;CACrB"}
@@ -21,7 +21,7 @@ export interface UrlConfig {
21
21
  * Build the full URL for a widget including query parameters
22
22
  *
23
23
  * @param widget - Widget identifier
24
- * @param props - Parameters to pass as query params
24
+ * @param props - Parameters to pass as a single JSON-encoded props param
25
25
  * @param config - URL configuration (baseUrl and port)
26
26
  * @returns Complete widget URL with encoded parameters
27
27
  */
@@ -1 +1 @@
1
- {"version":3,"file":"mcp-ui-adapter.d.ts","sourceRoot":"","sources":["../../../../src/server/adapters/mcp-ui-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAoB,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEtE,OAAO,KAAK,EACV,iBAAiB,EACjB,oBAAoB,EACpB,UAAU,EACV,eAAe,EAChB,MAAM,sBAAsB,CAAA;AAE7B;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,EACtC,MAAM,EAAE,SAAS,GAChB,MAAM,CAkBR;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,MAAM,EACjB,QAAQ,GAAE,UAAmB,EAC7B,QAAQ,CAAC,EAAE,cAAc,EACzB,QAAQ,CAAC,EAAE,eAAe,GACzB,iBAAiB,CAQnB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,QAAQ,GAAE,UAAmB,EAC7B,QAAQ,CAAC,EAAE,cAAc,EACzB,QAAQ,CAAC,EAAE,eAAe,GACzB,iBAAiB,CAQnB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,OAAO,GAAG,eAAyB,EAC9C,QAAQ,GAAE,UAAmB,EAC7B,QAAQ,CAAC,EAAE,cAAc,EACzB,QAAQ,CAAC,EAAE,eAAe,GACzB,iBAAiB,CAQnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,eAAe,GACzB,iBAAiB,CAkBnB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,oBAAoB,EAChC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,MAAM,EAAE,SAAS,GAChB,iBAAiB,CAuDnB"}
1
+ {"version":3,"file":"mcp-ui-adapter.d.ts","sourceRoot":"","sources":["../../../../src/server/adapters/mcp-ui-adapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAoB,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEtE,OAAO,KAAK,EACV,iBAAiB,EACjB,oBAAoB,EACpB,UAAU,EACV,eAAe,EAChB,MAAM,sBAAsB,CAAA;AAE7B;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,EACtC,MAAM,EAAE,SAAS,GAChB,MAAM,CAYR;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,MAAM,EACjB,QAAQ,GAAE,UAAmB,EAC7B,QAAQ,CAAC,EAAE,cAAc,EACzB,QAAQ,CAAC,EAAE,eAAe,GACzB,iBAAiB,CAQnB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,QAAQ,GAAE,UAAmB,EAC7B,QAAQ,CAAC,EAAE,cAAc,EACzB,QAAQ,CAAC,EAAE,eAAe,GACzB,iBAAiB,CAQnB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,OAAO,GAAG,eAAyB,EAC9C,QAAQ,GAAE,UAAmB,EAC7B,QAAQ,CAAC,EAAE,cAAc,EACzB,QAAQ,CAAC,EAAE,eAAe,GACzB,iBAAiB,CAQnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,eAAe,GACzB,iBAAiB,CAkBnB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,oBAAoB,EAChC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC3B,MAAM,EAAE,SAAS,GAChB,iBAAiB,CAuDnB"}