@qverisai/sdk 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -16
- package/dist/api/client.d.ts +29 -4
- package/dist/api/client.d.ts.map +1 -1
- package/dist/api/client.js +30 -3
- package/dist/api/client.js.map +1 -1
- package/dist/index.js +37 -2
- package/dist/index.js.map +1 -1
- package/dist/tools/get-by-ids.d.ts +69 -0
- package/dist/tools/get-by-ids.d.ts.map +1 -0
- package/dist/tools/get-by-ids.js +55 -0
- package/dist/tools/get-by-ids.js.map +1 -0
- package/dist/types.d.ts +31 -3
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,21 +7,12 @@ Official Qveris MCP Server SDK — Dynamically search and execute tools via natu
|
|
|
7
7
|
|
|
8
8
|
## Overview
|
|
9
9
|
|
|
10
|
-
This SDK provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that enables LLMs to discover and execute third-party tools through the Qveris API. With
|
|
10
|
+
This SDK provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that enables LLMs to discover and execute third-party tools through the Qveris API. With three simple tools, your AI assistant can:
|
|
11
11
|
|
|
12
12
|
- **Search** for tools using natural language queries
|
|
13
|
+
- **Get** detailed information about specific tools by their IDs
|
|
13
14
|
- **Execute** any discovered tool with the appropriate parameters
|
|
14
15
|
|
|
15
|
-
## Installation
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
# Using npx (recommended for MCP)
|
|
19
|
-
npx @qverisai/sdk
|
|
20
|
-
|
|
21
|
-
# Or install globally
|
|
22
|
-
npm add -g @qverisai/sdk
|
|
23
|
-
```
|
|
24
|
-
|
|
25
16
|
## Quick Start
|
|
26
17
|
|
|
27
18
|
### 1. Get Your API Key
|
|
@@ -96,7 +87,7 @@ Search for available tools based on natural language queries.
|
|
|
96
87
|
```json
|
|
97
88
|
{
|
|
98
89
|
"query": "send email notification",
|
|
99
|
-
"limit":
|
|
90
|
+
"limit": 10
|
|
100
91
|
}
|
|
101
92
|
```
|
|
102
93
|
|
|
@@ -116,12 +107,31 @@ Execute a discovered tool with specific parameters.
|
|
|
116
107
|
|
|
117
108
|
```json
|
|
118
109
|
{
|
|
119
|
-
"tool_id": "
|
|
120
|
-
"search_id": "
|
|
110
|
+
"tool_id": "openweathermap.weather.execute.v1",
|
|
111
|
+
"search_id": "abcd1234-ab12-ab12-ab12-abcdef123456",
|
|
121
112
|
"params_to_tool": "{\"city\": \"London\", \"units\": \"metric\"}"
|
|
122
113
|
}
|
|
123
114
|
```
|
|
124
115
|
|
|
116
|
+
### `get_tools_by_ids`
|
|
117
|
+
|
|
118
|
+
Get detailed descriptions of tools based on their tool IDs. Useful for retrieving information about specific tools when you already know their IDs from previous searches.
|
|
119
|
+
|
|
120
|
+
| Parameter | Type | Required | Description |
|
|
121
|
+
|-----------|------|----------|-------------|
|
|
122
|
+
| `tool_ids` | array | ✓ | Array of tool IDs to retrieve (at least one required) |
|
|
123
|
+
| `search_id` | string | | Search ID from the search that returned the tool(s) |
|
|
124
|
+
| `session_id` | string | | Session identifier (auto-generated if omitted) |
|
|
125
|
+
|
|
126
|
+
**Example:**
|
|
127
|
+
|
|
128
|
+
```json
|
|
129
|
+
{
|
|
130
|
+
"tool_ids": ["openweathermap.weather.execute.v1", "worldbank_refined.search_indicators.v1"],
|
|
131
|
+
"search_id": "abcd1234-ab12-ab12-ab12-abcdef123456"
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
125
135
|
## Session Management
|
|
126
136
|
|
|
127
137
|
Providing a consistent `session_id` in a same user session in any tool call enables:
|
|
@@ -137,8 +147,8 @@ If not provided, the SDK automatically generates and maintains a session ID for
|
|
|
137
147
|
|
|
138
148
|
```json
|
|
139
149
|
{
|
|
140
|
-
"execution_id": "
|
|
141
|
-
"tool_id": "
|
|
150
|
+
"execution_id": "abcd1234-ab12-ab12-ab12-abcdef123456",
|
|
151
|
+
"tool_id": "openweathermap.weather.execute.v1",
|
|
142
152
|
"success": true,
|
|
143
153
|
"result": {
|
|
144
154
|
"data": {
|
package/dist/api/client.d.ts
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* @module api/client
|
|
8
8
|
*/
|
|
9
|
-
import type { SearchRequest, SearchResponse, ExecuteRequest, ExecuteResponse, QverisClientConfig } from '../types.js';
|
|
9
|
+
import type { SearchRequest, SearchResponse, GetToolsByIdsRequest, ExecuteRequest, ExecuteResponse, QverisClientConfig } from '../types.js';
|
|
10
10
|
/**
|
|
11
11
|
* Qveris API Client
|
|
12
12
|
*
|
|
@@ -64,7 +64,7 @@ export declare class QverisClient {
|
|
|
64
64
|
* const result = await client.searchTools({
|
|
65
65
|
* query: 'send SMS message',
|
|
66
66
|
* limit: 10,
|
|
67
|
-
* session_id: '
|
|
67
|
+
* session_id: 'abcd1234-ab12-ab12-ab12-abcdef123456'
|
|
68
68
|
* });
|
|
69
69
|
*
|
|
70
70
|
* console.log(`Found ${result.total} tools`);
|
|
@@ -74,6 +74,31 @@ export declare class QverisClient {
|
|
|
74
74
|
* ```
|
|
75
75
|
*/
|
|
76
76
|
searchTools(request: SearchRequest): Promise<SearchResponse>;
|
|
77
|
+
/**
|
|
78
|
+
* Get tool descriptions by their IDs.
|
|
79
|
+
*
|
|
80
|
+
* Retrieves detailed information about specific tools when you already
|
|
81
|
+
* know their tool_ids. Useful for refreshing tool metadata or getting
|
|
82
|
+
* details for tools from previous searches.
|
|
83
|
+
*
|
|
84
|
+
* @param request - Request parameters with tool IDs
|
|
85
|
+
* @returns Tool information matching the provided IDs
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```typescript
|
|
89
|
+
* const result = await client.getToolsByIds({
|
|
90
|
+
* tool_ids: ['weather-tool-1', 'email-tool-2'],
|
|
91
|
+
* search_id: 'abcd1234-ab12-ab12-ab12-abcdef123456',
|
|
92
|
+
* session_id: 'abcd1234-ab12-ab12-ab12-abcdef123456'
|
|
93
|
+
* });
|
|
94
|
+
*
|
|
95
|
+
* console.log(`Retrieved ${result.results.length} tools`);
|
|
96
|
+
* for (const tool of result.results) {
|
|
97
|
+
* console.log(`- ${tool.name}: ${tool.description}`);
|
|
98
|
+
* }
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
101
|
+
getToolsByIds(request: GetToolsByIdsRequest): Promise<SearchResponse>;
|
|
77
102
|
/**
|
|
78
103
|
* Execute a tool with the specified parameters.
|
|
79
104
|
*
|
|
@@ -87,8 +112,8 @@ export declare class QverisClient {
|
|
|
87
112
|
* @example
|
|
88
113
|
* ```typescript
|
|
89
114
|
* const result = await client.executeTool('openweathermap_current', {
|
|
90
|
-
* search_id: '
|
|
91
|
-
* session_id: '
|
|
115
|
+
* search_id: 'abcd1234-ab12-ab12-ab12-abcdef123456',
|
|
116
|
+
* session_id: 'abcd1234-ab12-ab12-ab12-abcdef123456',
|
|
92
117
|
* parameters: {
|
|
93
118
|
* city: 'Tokyo',
|
|
94
119
|
* units: 'metric'
|
package/dist/api/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,cAAc,EACd,eAAe,EACf,kBAAkB,EAEnB,MAAM,aAAa,CAAC;AAKrB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;;;;OAKG;gBACS,MAAM,EAAE,kBAAkB;IAQtC;;;;;;;;OAQG;YACW,OAAO;IA2CrB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAIlE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,eAAe,CAAC;CAI5B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAYlD"}
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,kBAAkB,EAEnB,MAAM,aAAa,CAAC;AAKrB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;;;;OAKG;gBACS,MAAM,EAAE,kBAAkB;IAQtC;;;;;;;;OAQG;YACW,OAAO;IA2CrB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAIlE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC;IAI3E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,eAAe,CAAC;CAI5B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,IAAI,YAAY,CAYlD"}
|
package/dist/api/client.js
CHANGED
|
@@ -103,7 +103,7 @@ export class QverisClient {
|
|
|
103
103
|
* const result = await client.searchTools({
|
|
104
104
|
* query: 'send SMS message',
|
|
105
105
|
* limit: 10,
|
|
106
|
-
* session_id: '
|
|
106
|
+
* session_id: 'abcd1234-ab12-ab12-ab12-abcdef123456'
|
|
107
107
|
* });
|
|
108
108
|
*
|
|
109
109
|
* console.log(`Found ${result.total} tools`);
|
|
@@ -115,6 +115,33 @@ export class QverisClient {
|
|
|
115
115
|
async searchTools(request) {
|
|
116
116
|
return this.request('POST', '/search', request);
|
|
117
117
|
}
|
|
118
|
+
/**
|
|
119
|
+
* Get tool descriptions by their IDs.
|
|
120
|
+
*
|
|
121
|
+
* Retrieves detailed information about specific tools when you already
|
|
122
|
+
* know their tool_ids. Useful for refreshing tool metadata or getting
|
|
123
|
+
* details for tools from previous searches.
|
|
124
|
+
*
|
|
125
|
+
* @param request - Request parameters with tool IDs
|
|
126
|
+
* @returns Tool information matching the provided IDs
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* ```typescript
|
|
130
|
+
* const result = await client.getToolsByIds({
|
|
131
|
+
* tool_ids: ['weather-tool-1', 'email-tool-2'],
|
|
132
|
+
* search_id: 'abcd1234-ab12-ab12-ab12-abcdef123456',
|
|
133
|
+
* session_id: 'abcd1234-ab12-ab12-ab12-abcdef123456'
|
|
134
|
+
* });
|
|
135
|
+
*
|
|
136
|
+
* console.log(`Retrieved ${result.results.length} tools`);
|
|
137
|
+
* for (const tool of result.results) {
|
|
138
|
+
* console.log(`- ${tool.name}: ${tool.description}`);
|
|
139
|
+
* }
|
|
140
|
+
* ```
|
|
141
|
+
*/
|
|
142
|
+
async getToolsByIds(request) {
|
|
143
|
+
return this.request('POST', '/tools/by-ids', request);
|
|
144
|
+
}
|
|
118
145
|
/**
|
|
119
146
|
* Execute a tool with the specified parameters.
|
|
120
147
|
*
|
|
@@ -128,8 +155,8 @@ export class QverisClient {
|
|
|
128
155
|
* @example
|
|
129
156
|
* ```typescript
|
|
130
157
|
* const result = await client.executeTool('openweathermap_current', {
|
|
131
|
-
* search_id: '
|
|
132
|
-
* session_id: '
|
|
158
|
+
* search_id: 'abcd1234-ab12-ab12-ab12-abcdef123456',
|
|
159
|
+
* session_id: 'abcd1234-ab12-ab12-ab12-abcdef123456',
|
|
133
160
|
* parameters: {
|
|
134
161
|
* city: 'Tokyo',
|
|
135
162
|
* units: 'metric'
|
package/dist/api/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAYH,8BAA8B;AAC9B,MAAM,gBAAgB,GAAG,0BAA0B,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,YAAY;IACN,MAAM,CAAS;IACf,OAAO,CAAS;IAEjC;;;;;OAKG;IACH,YAAY,MAA0B;QACpC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,gBAAgB,CAAC;IACpD,CAAC;IAED;;;;;;;;OAQG;IACK,KAAK,CAAC,OAAO,CACnB,MAAsB,EACtB,QAAgB,EAChB,IAAc;QAEd,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,CAAC;QAEzC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM;YACN,OAAO,EAAE;gBACP,eAAe,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;gBACxC,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;SAC9C,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,YAAoB,CAAC;YACzB,IAAI,YAAqB,CAAC;YAE1B,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA4B,CAAC;gBACrE,YAAY;oBACT,SAAS,CAAC,OAAkB;wBAC5B,SAAS,CAAC,KAAgB;wBAC3B,QAAQ,CAAC,UAAU,CAAC;gBACtB,YAAY,GAAG,SAAS,CAAC;YAC3B,CAAC;YAAC,MAAM,CAAC;gBACP,YAAY,GAAG,QAAQ,CAAC,UAAU,IAAI,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;YAClE,CAAC;YAED,MAAM,KAAK,GAAa;gBACtB,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,OAAO,EAAE,YAAY;gBACrB,OAAO,EAAE,YAAY;aACtB,CAAC;YAEF,MAAM,KAAK,CAAC;QACd,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAgB,CAAC;IACvC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,WAAW,CAAC,OAAsB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAiB,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,aAAa,CAAC,OAA6B;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAiB,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,WAAW,CACf,MAAc,EACd,OAAuB;QAEvB,MAAM,QAAQ,GAAG,0BAA0B,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QACxE,OAAO,IAAI,CAAC,OAAO,CAAkB,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,mBAAmB;IACjC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;IAE1C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CACb,oDAAoD;YACpD,2CAA2C;YAC3C,wCAAwC,CACzC,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AACtC,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -30,6 +30,7 @@ import { v4 as uuidv4 } from 'uuid';
|
|
|
30
30
|
import { createClientFromEnv } from './api/client.js';
|
|
31
31
|
import { searchToolsSchema, executeSearchTools, } from './tools/search.js';
|
|
32
32
|
import { executeToolSchema, executeExecuteTool, } from './tools/execute.js';
|
|
33
|
+
import { getToolsByIdsSchema, executeGetToolsByIds, } from './tools/get-by-ids.js';
|
|
33
34
|
// ============================================================================
|
|
34
35
|
// Server Configuration
|
|
35
36
|
// ============================================================================
|
|
@@ -67,7 +68,7 @@ async function main() {
|
|
|
67
68
|
// =========================================================================
|
|
68
69
|
/**
|
|
69
70
|
* Lists available tools.
|
|
70
|
-
* Returns the search_tools and execute_tool definitions.
|
|
71
|
+
* Returns the search_tools, get_tools_by_ids, and execute_tool definitions.
|
|
71
72
|
*/
|
|
72
73
|
server.setRequestHandler(ListToolsRequestSchema, async () => {
|
|
73
74
|
return {
|
|
@@ -79,6 +80,13 @@ async function main() {
|
|
|
79
80
|
'Use this to discover tools before executing them.',
|
|
80
81
|
inputSchema: searchToolsSchema,
|
|
81
82
|
},
|
|
83
|
+
{
|
|
84
|
+
name: 'get_tools_by_ids',
|
|
85
|
+
description: 'Get descriptions of tools based on their tool IDs. ' +
|
|
86
|
+
'Useful for retrieving detailed information about specific tools ' +
|
|
87
|
+
'when you already know their tool_ids from previous searches.',
|
|
88
|
+
inputSchema: getToolsByIdsSchema,
|
|
89
|
+
},
|
|
82
90
|
{
|
|
83
91
|
name: 'execute_tool',
|
|
84
92
|
description: 'Execute a specific remote tool with provided parameters. ' +
|
|
@@ -123,6 +131,33 @@ async function main() {
|
|
|
123
131
|
],
|
|
124
132
|
};
|
|
125
133
|
}
|
|
134
|
+
if (name === 'get_tools_by_ids') {
|
|
135
|
+
const input = args;
|
|
136
|
+
// Validate required fields
|
|
137
|
+
if (!input.tool_ids || !Array.isArray(input.tool_ids) || input.tool_ids.length === 0) {
|
|
138
|
+
return {
|
|
139
|
+
content: [
|
|
140
|
+
{
|
|
141
|
+
type: 'text',
|
|
142
|
+
text: JSON.stringify({
|
|
143
|
+
error: 'Missing or invalid required parameter: tool_ids',
|
|
144
|
+
hint: 'Provide an array of tool IDs (at least one) to retrieve tool information',
|
|
145
|
+
}),
|
|
146
|
+
},
|
|
147
|
+
],
|
|
148
|
+
isError: true,
|
|
149
|
+
};
|
|
150
|
+
}
|
|
151
|
+
const result = await executeGetToolsByIds(client, input, defaultSessionId);
|
|
152
|
+
return {
|
|
153
|
+
content: [
|
|
154
|
+
{
|
|
155
|
+
type: 'text',
|
|
156
|
+
text: JSON.stringify(result, null, 2),
|
|
157
|
+
},
|
|
158
|
+
],
|
|
159
|
+
};
|
|
160
|
+
}
|
|
126
161
|
if (name === 'execute_tool') {
|
|
127
162
|
const input = args;
|
|
128
163
|
// Validate required fields
|
|
@@ -164,7 +199,7 @@ async function main() {
|
|
|
164
199
|
type: 'text',
|
|
165
200
|
text: JSON.stringify({
|
|
166
201
|
error: `Unknown tool: ${name}`,
|
|
167
|
-
available_tools: ['search_tools', 'execute_tool'],
|
|
202
|
+
available_tools: ['search_tools', 'get_tools_by_ids', 'execute_tool'],
|
|
168
203
|
}),
|
|
169
204
|
},
|
|
170
205
|
],
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GAEvB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,mBAAmB,EAAgB,MAAM,iBAAiB,CAAC;AACpE,OAAO,EACL,iBAAiB,EACjB,kBAAkB,GAEnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,iBAAiB,EACjB,kBAAkB,GAEnB,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EACL,qBAAqB,EACrB,sBAAsB,GAEvB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EAAE,mBAAmB,EAAgB,MAAM,iBAAiB,CAAC;AACpE,OAAO,EACL,iBAAiB,EACjB,kBAAkB,GAEnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,iBAAiB,EACjB,kBAAkB,GAEnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,mBAAmB,EACnB,oBAAoB,GAErB,MAAM,uBAAuB,CAAC;AAG/B,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E,MAAM,WAAW,GAAG,QAAQ,CAAC;AAC7B,MAAM,cAAc,GAAG,OAAO,CAAC;AAE/B;;;;;GAKG;AACH,KAAK,UAAU,IAAI;IACjB,mDAAmD;IACnD,IAAI,MAAoB,CAAC;IACzB,IAAI,CAAC;QACH,MAAM,GAAG,mBAAmB,EAAE,CAAC;IACjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,oCAAoC,CAC9E,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,yDAAyD;IACzD,MAAM,gBAAgB,GAAG,MAAM,EAAE,CAAC;IAElC,oBAAoB;IACpB,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB;QACE,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,cAAc;KACxB,EACD;QACE,YAAY,EAAE;YACZ,KAAK,EAAE,EAAE;SACV;KACF,CACF,CAAC;IAEF,4EAA4E;IAC5E,gBAAgB;IAChB,4EAA4E;IAE5E;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QAC1D,OAAO;YACL,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,cAAc;oBACpB,WAAW,EACT,gEAAgE;wBAChE,yDAAyD;wBACzD,mDAAmD;oBACrD,WAAW,EAAE,iBAAiB;iBAC/B;gBACD;oBACE,IAAI,EAAE,kBAAkB;oBACxB,WAAW,EACT,qDAAqD;wBACrD,kEAAkE;wBAClE,8DAA8D;oBAChE,WAAW,EAAE,mBAAmB;iBACjC;gBACD;oBACE,IAAI,EAAE,cAAc;oBACpB,WAAW,EACT,2DAA2D;wBAC3D,yEAAyE;wBACzE,sEAAsE;oBACxE,WAAW,EAAE,iBAAiB;iBAC/B;aACF;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,qBAAqB,EAAE,KAAK,EAAE,OAAO,EAA2B,EAAE;QACzF,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;QAEjD,IAAI,CAAC;YACH,IAAI,IAAI,KAAK,cAAc,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,IAAmC,CAAC;gBAElD,2BAA2B;gBAC3B,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACpD,OAAO;wBACL,OAAO,EAAE;4BACP;gCACE,IAAI,EAAE,MAAM;gCACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oCACnB,KAAK,EAAE,mCAAmC;oCAC1C,IAAI,EAAE,0EAA0E;iCACjF,CAAC;6BACH;yBACF;wBACD,OAAO,EAAE,IAAI;qBACd,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,gBAAgB,CAAC,CAAC;gBAEzE,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;yBACtC;qBACF;iBACF,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,KAAK,kBAAkB,EAAE,CAAC;gBAChC,MAAM,KAAK,GAAG,IAAqC,CAAC;gBAEpD,2BAA2B;gBAC3B,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACrF,OAAO;wBACL,OAAO,EAAE;4BACP;gCACE,IAAI,EAAE,MAAM;gCACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oCACnB,KAAK,EAAE,iDAAiD;oCACxD,IAAI,EAAE,0EAA0E;iCACjF,CAAC;6BACH;yBACF;wBACD,OAAO,EAAE,IAAI;qBACd,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,gBAAgB,CAAC,CAAC;gBAE3E,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;yBACtC;qBACF;iBACF,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,KAAK,cAAc,EAAE,CAAC;gBAC5B,MAAM,KAAK,GAAG,IAAmC,CAAC;gBAElD,2BAA2B;gBAC3B,MAAM,aAAa,GAAa,EAAE,CAAC;gBACnC,IAAI,CAAC,KAAK,CAAC,OAAO;oBAAE,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAClD,IAAI,CAAC,KAAK,CAAC,SAAS;oBAAE,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACtD,IAAI,CAAC,KAAK,CAAC,cAAc;oBAAE,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBAEhE,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC7B,OAAO;wBACL,OAAO,EAAE;4BACP;gCACE,IAAI,EAAE,MAAM;gCACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oCACnB,KAAK,EAAE,gCAAgC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oCACjE,IAAI,EAAE,mEAAmE;iCAC1E,CAAC;6BACH;yBACF;wBACD,OAAO,EAAE,IAAI;qBACd,CAAC;gBACJ,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,gBAAgB,CAAC,CAAC;gBAEzE,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;yBACtC;qBACF;iBACF,CAAC;YACJ,CAAC;YAED,eAAe;YACf,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;4BACnB,KAAK,EAAE,iBAAiB,IAAI,EAAE;4BAC9B,eAAe,EAAE,CAAC,cAAc,EAAE,kBAAkB,EAAE,cAAc,CAAC;yBACtE,CAAC;qBACH;iBACF;gBACD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,oBAAoB;YACpB,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtB,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gCACnB,KAAK,EAAE,KAAK,CAAC,OAAO;gCACpB,MAAM,EAAE,KAAK,CAAC,MAAM;gCACpB,OAAO,EAAE,KAAK,CAAC,OAAO;6BACvB,CAAC;yBACH;qBACF;oBACD,OAAO,EAAE,IAAI;iBACd,CAAC;YACJ,CAAC;YAED,uDAAuD;YACvD,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,wBAAwB,CAAC;YACvF,MAAM,UAAU,GAAG,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,KAAK,YAAY,KAAK;gBACvE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO;gBACrB,CAAC,CAAC,SAAS,CAAC;YAEd,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;4BACnB,KAAK,EAAE,YAAY;4BACnB,GAAG,CAAC,UAAU,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;yBACzC,CAAC;qBACH;iBACF;gBACD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,4EAA4E;IAC5E,eAAe;IACf,4EAA4E;IAE5E,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAEhC,8DAA8D;IAC9D,OAAO,CAAC,KAAK,CAAC,sBAAsB,cAAc,UAAU,CAAC,CAAC;IAC9D,OAAO,CAAC,KAAK,CAAC,eAAe,gBAAgB,EAAE,CAAC,CAAC;AACnD,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,KAAc;IAChC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,QAAQ,IAAI,KAAK;QACjB,SAAS,IAAI,KAAK,CACnB,CAAC;AACJ,CAAC;AAED,iBAAiB;AACjB,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IACrC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* get_tools_by_ids MCP Tool Implementation
|
|
3
|
+
*
|
|
4
|
+
* Retrieves tool descriptions based on tool IDs.
|
|
5
|
+
* Useful for getting detailed information about specific tools
|
|
6
|
+
* when you already know their tool_ids.
|
|
7
|
+
*
|
|
8
|
+
* @module tools/get-by-ids
|
|
9
|
+
*/
|
|
10
|
+
import type { QverisClient } from '../api/client.js';
|
|
11
|
+
import type { SearchResponse } from '../types.js';
|
|
12
|
+
/**
|
|
13
|
+
* Input parameters for the get_tools_by_ids tool.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetToolsByIdsInput {
|
|
16
|
+
/**
|
|
17
|
+
* Array of tool IDs to retrieve information for.
|
|
18
|
+
* Must be obtained from previous search_tools results.
|
|
19
|
+
*
|
|
20
|
+
* @example ["weather-tool-1", "email-tool-2"]
|
|
21
|
+
*/
|
|
22
|
+
tool_ids: string[];
|
|
23
|
+
/**
|
|
24
|
+
* The search_id from the search_tools response that returned the tool(s).
|
|
25
|
+
* Optional but recommended for analytics and billing.
|
|
26
|
+
*/
|
|
27
|
+
search_id?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Session identifier for tracking user sessions.
|
|
30
|
+
* If not provided, the server will use an auto-generated session ID.
|
|
31
|
+
*/
|
|
32
|
+
session_id?: string;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* JSON Schema for the get_tools_by_ids tool input.
|
|
36
|
+
* Used by MCP to validate and document the tool parameters.
|
|
37
|
+
*/
|
|
38
|
+
export declare const getToolsByIdsSchema: {
|
|
39
|
+
type: "object";
|
|
40
|
+
properties: {
|
|
41
|
+
tool_ids: {
|
|
42
|
+
type: string;
|
|
43
|
+
items: {
|
|
44
|
+
type: string;
|
|
45
|
+
};
|
|
46
|
+
description: string;
|
|
47
|
+
minItems: number;
|
|
48
|
+
};
|
|
49
|
+
search_id: {
|
|
50
|
+
type: string;
|
|
51
|
+
description: string;
|
|
52
|
+
};
|
|
53
|
+
session_id: {
|
|
54
|
+
type: string;
|
|
55
|
+
description: string;
|
|
56
|
+
};
|
|
57
|
+
};
|
|
58
|
+
required: string[];
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* Executes the get_tools_by_ids operation.
|
|
62
|
+
*
|
|
63
|
+
* @param client - Initialized Qveris API client
|
|
64
|
+
* @param input - Request parameters with tool IDs
|
|
65
|
+
* @param defaultSessionId - Fallback session ID if not provided in input
|
|
66
|
+
* @returns Tool information for the requested IDs
|
|
67
|
+
*/
|
|
68
|
+
export declare function executeGetToolsByIds(client: QverisClient, input: GetToolsByIdsInput, defaultSessionId: string): Promise<SearchResponse>;
|
|
69
|
+
//# sourceMappingURL=get-by-ids.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-by-ids.d.ts","sourceRoot":"","sources":["../../src/tools/get-by-ids.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;CA2B/B,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,YAAY,EACpB,KAAK,EAAE,kBAAkB,EACzB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,cAAc,CAAC,CAQzB"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* get_tools_by_ids MCP Tool Implementation
|
|
3
|
+
*
|
|
4
|
+
* Retrieves tool descriptions based on tool IDs.
|
|
5
|
+
* Useful for getting detailed information about specific tools
|
|
6
|
+
* when you already know their tool_ids.
|
|
7
|
+
*
|
|
8
|
+
* @module tools/get-by-ids
|
|
9
|
+
*/
|
|
10
|
+
/**
|
|
11
|
+
* JSON Schema for the get_tools_by_ids tool input.
|
|
12
|
+
* Used by MCP to validate and document the tool parameters.
|
|
13
|
+
*/
|
|
14
|
+
export const getToolsByIdsSchema = {
|
|
15
|
+
type: 'object',
|
|
16
|
+
properties: {
|
|
17
|
+
tool_ids: {
|
|
18
|
+
type: 'array',
|
|
19
|
+
items: {
|
|
20
|
+
type: 'string',
|
|
21
|
+
},
|
|
22
|
+
description: 'Array of tool IDs to retrieve information for. ' +
|
|
23
|
+
'These IDs should come from previous search_tools results.',
|
|
24
|
+
minItems: 1,
|
|
25
|
+
},
|
|
26
|
+
search_id: {
|
|
27
|
+
type: 'string',
|
|
28
|
+
description: 'The search_id from the search_tools response that returned the tool(s). ' +
|
|
29
|
+
'Optional but recommended for linking to the original search.',
|
|
30
|
+
},
|
|
31
|
+
session_id: {
|
|
32
|
+
type: 'string',
|
|
33
|
+
description: 'Session identifier for tracking user sessions. ' +
|
|
34
|
+
'If not provided, an auto-generated session ID will be used.',
|
|
35
|
+
},
|
|
36
|
+
},
|
|
37
|
+
required: ['tool_ids'],
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* Executes the get_tools_by_ids operation.
|
|
41
|
+
*
|
|
42
|
+
* @param client - Initialized Qveris API client
|
|
43
|
+
* @param input - Request parameters with tool IDs
|
|
44
|
+
* @param defaultSessionId - Fallback session ID if not provided in input
|
|
45
|
+
* @returns Tool information for the requested IDs
|
|
46
|
+
*/
|
|
47
|
+
export async function executeGetToolsByIds(client, input, defaultSessionId) {
|
|
48
|
+
const response = await client.getToolsByIds({
|
|
49
|
+
tool_ids: input.tool_ids,
|
|
50
|
+
search_id: input.search_id,
|
|
51
|
+
session_id: input.session_id ?? defaultSessionId,
|
|
52
|
+
});
|
|
53
|
+
return response;
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=get-by-ids.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-by-ids.js","sourceRoot":"","sources":["../../src/tools/get-by-ids.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AA8BH;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,IAAI,EAAE,QAAiB;IACvB,UAAU,EAAE;QACV,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;YACD,WAAW,EACT,iDAAiD;gBACjD,2DAA2D;YAC7D,QAAQ,EAAE,CAAC;SACZ;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,0EAA0E;gBAC1E,8DAA8D;SACjE;QACD,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,iDAAiD;gBACjD,6DAA6D;SAChE;KACF;IACD,QAAQ,EAAE,CAAC,UAAU,CAAC;CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAoB,EACpB,KAAyB,EACzB,gBAAwB;IAExB,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC;QAC1C,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,gBAAgB;KACjD,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC;AAClB,CAAC"}
|
package/dist/types.d.ts
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
* const request: SearchRequest = {
|
|
16
16
|
* query: "weather forecast API",
|
|
17
17
|
* limit: 10,
|
|
18
|
-
* session_id: "
|
|
18
|
+
* session_id: "abcd1234-ab12-ab12-ab12-abcdef123456"
|
|
19
19
|
* };
|
|
20
20
|
* ```
|
|
21
21
|
*/
|
|
@@ -116,14 +116,42 @@ export interface SearchResponse {
|
|
|
116
116
|
/** Search performance statistics */
|
|
117
117
|
stats?: SearchStats;
|
|
118
118
|
}
|
|
119
|
+
/**
|
|
120
|
+
* Request body for the Get Tools by IDs API.
|
|
121
|
+
*
|
|
122
|
+
* @example
|
|
123
|
+
* ```typescript
|
|
124
|
+
* const request: GetToolsByIdsRequest = {
|
|
125
|
+
* tool_ids: ["tool-1", "tool-2"],
|
|
126
|
+
* search_id: "search-123",
|
|
127
|
+
* session_id: "abcd1234-ab12-ab12-ab12-abcdef123456"
|
|
128
|
+
* };
|
|
129
|
+
* ```
|
|
130
|
+
*/
|
|
131
|
+
export interface GetToolsByIdsRequest {
|
|
132
|
+
/**
|
|
133
|
+
* Array of tool IDs to retrieve information for.
|
|
134
|
+
*/
|
|
135
|
+
tool_ids: string[];
|
|
136
|
+
/**
|
|
137
|
+
* The search_id from the search that returned the tool(s).
|
|
138
|
+
* Optional but recommended for analytics and billing.
|
|
139
|
+
*/
|
|
140
|
+
search_id?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Session identifier for tracking user sessions.
|
|
143
|
+
* Same ID corresponds to the same user session.
|
|
144
|
+
*/
|
|
145
|
+
session_id?: string;
|
|
146
|
+
}
|
|
119
147
|
/**
|
|
120
148
|
* Request body for the Execute Tool API.
|
|
121
149
|
*
|
|
122
150
|
* @example
|
|
123
151
|
* ```typescript
|
|
124
152
|
* const request: ExecuteRequest = {
|
|
125
|
-
* search_id: "
|
|
126
|
-
* session_id: "
|
|
153
|
+
* search_id: "abcd1234-ab12-ab12-ab12-abcdef123456",
|
|
154
|
+
* session_id: "abcd1234-ab12-ab12-ab12-abcdef123456",
|
|
127
155
|
* parameters: { city: "London", units: "metric" },
|
|
128
156
|
* max_response_size: 20480
|
|
129
157
|
* };
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IAEb,iCAAiC;IACjC,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;IAE3D,8CAA8C;IAC9C,QAAQ,EAAE,OAAO,CAAC;IAElB,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;IAEpB,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAEhB,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IAEb,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IAEpB,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,kCAAkC;IAClC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+CAA+C;IAC/C,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IAEzB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,8BAA8B;IAC9B,OAAO,EAAE,QAAQ,EAAE,CAAC;IAEpB,oCAAoC;IACpC,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAMD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,qDAAqD;IACrD,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,sBAAsB,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,YAAY,EAAE,MAAM,CAAC;IAErB,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAEhB,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;;OAGG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,mDAAmD;IACnD,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,oCAAoC;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IAEf,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IAEf,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAEhB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IAEb,iCAAiC;IACjC,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;IAE3D,8CAA8C;IAC9C,QAAQ,EAAE,OAAO,CAAC;IAElB,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;IAEpB,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAEhB,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IAEb,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IAEpB,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,kCAAkC;IAClC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+CAA+C;IAC/C,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IAEzB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,8BAA8B;IAC9B,OAAO,EAAE,QAAQ,EAAE,CAAC;IAEpB,oCAAoC;IACpC,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAMD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,qDAAqD;IACrD,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,sBAAsB,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,YAAY,EAAE,MAAM,CAAC;IAErB,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAEhB,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEpC;;;OAGG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB,mDAAmD;IACnD,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,oCAAoC;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IAEf,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IAEf,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAEhB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}
|