tuix-mcp-host-client 0.0.151 → 0.0.153
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/.openapi-generator/FILES +8 -6
- package/apis/ClientApi.js +66 -68
- package/apis/ClientApi.js.map +1 -1
- package/apis/ClientApi.ts +117 -127
- package/docs/ClientApi.md +94 -100
- package/docs/SearchToolsResponseDTO.md +44 -0
- package/docs/{MCPServerToolDTO.md → ToolDTO.md} +8 -8
- package/docs/{CallMCPServerToolDTO.md → ToolMatchDTO.md} +12 -8
- package/docs/{CallMCPServerToolResultDTO.md → UpdateMCPServerDTO.md} +8 -6
- package/models/SearchToolsResponseDTO.js +69 -0
- package/models/SearchToolsResponseDTO.js.map +1 -0
- package/models/SearchToolsResponseDTO.ts +112 -0
- package/models/ToolDTO.js +61 -0
- package/models/ToolDTO.js.map +1 -0
- package/models/{MCPServerToolDTO.ts → ToolDTO.ts} +19 -17
- package/models/ToolMatchDTO.js +71 -0
- package/models/ToolMatchDTO.js.map +1 -0
- package/models/ToolMatchDTO.ts +96 -0
- package/models/UpdateMCPServerDTO.js +51 -0
- package/models/UpdateMCPServerDTO.js.map +1 -0
- package/models/UpdateMCPServerDTO.ts +69 -0
- package/models/index.js +4 -3
- package/models/index.js.map +1 -1
- package/models/index.ts +4 -3
- package/package.json +1 -1
- package/tsconfig.build.tsbuildinfo +1 -1
- package/models/CallMCPServerToolDTO.js +0 -51
- package/models/CallMCPServerToolDTO.js.map +0 -1
- package/models/CallMCPServerToolDTO.ts +0 -69
- package/models/CallMCPServerToolResultDTO.js +0 -49
- package/models/CallMCPServerToolResultDTO.js.map +0 -1
- package/models/CallMCPServerToolResultDTO.ts +0 -63
- package/models/MCPServerToolDTO.js +0 -57
- package/models/MCPServerToolDTO.js.map +0 -1
package/apis/ClientApi.ts
CHANGED
|
@@ -33,16 +33,6 @@ import {
|
|
|
33
33
|
ApplicationMCPServerDTOFromJSON,
|
|
34
34
|
ApplicationMCPServerDTOToJSON,
|
|
35
35
|
} from '../models/ApplicationMCPServerDTO';
|
|
36
|
-
import {
|
|
37
|
-
type CallMCPServerToolDTO,
|
|
38
|
-
CallMCPServerToolDTOFromJSON,
|
|
39
|
-
CallMCPServerToolDTOToJSON,
|
|
40
|
-
} from '../models/CallMCPServerToolDTO';
|
|
41
|
-
import {
|
|
42
|
-
type CallMCPServerToolResultDTO,
|
|
43
|
-
CallMCPServerToolResultDTOFromJSON,
|
|
44
|
-
CallMCPServerToolResultDTOToJSON,
|
|
45
|
-
} from '../models/CallMCPServerToolResultDTO';
|
|
46
36
|
import {
|
|
47
37
|
type CreateAPIKeyRequestDTO,
|
|
48
38
|
CreateAPIKeyRequestDTOFromJSON,
|
|
@@ -88,11 +78,6 @@ import {
|
|
|
88
78
|
MCPServerStatusDTOFromJSON,
|
|
89
79
|
MCPServerStatusDTOToJSON,
|
|
90
80
|
} from '../models/MCPServerStatusDTO';
|
|
91
|
-
import {
|
|
92
|
-
type MCPServerToolDTO,
|
|
93
|
-
MCPServerToolDTOFromJSON,
|
|
94
|
-
MCPServerToolDTOToJSON,
|
|
95
|
-
} from '../models/MCPServerToolDTO';
|
|
96
81
|
import {
|
|
97
82
|
type PaginatedApplicationsDTO,
|
|
98
83
|
PaginatedApplicationsDTOFromJSON,
|
|
@@ -103,11 +88,21 @@ import {
|
|
|
103
88
|
PaginatedMCPServerDTOFromJSON,
|
|
104
89
|
PaginatedMCPServerDTOToJSON,
|
|
105
90
|
} from '../models/PaginatedMCPServerDTO';
|
|
91
|
+
import {
|
|
92
|
+
type SearchToolsResponseDTO,
|
|
93
|
+
SearchToolsResponseDTOFromJSON,
|
|
94
|
+
SearchToolsResponseDTOToJSON,
|
|
95
|
+
} from '../models/SearchToolsResponseDTO';
|
|
106
96
|
import {
|
|
107
97
|
type UpdateApplicationDTO,
|
|
108
98
|
UpdateApplicationDTOFromJSON,
|
|
109
99
|
UpdateApplicationDTOToJSON,
|
|
110
100
|
} from '../models/UpdateApplicationDTO';
|
|
101
|
+
import {
|
|
102
|
+
type UpdateMCPServerDTO,
|
|
103
|
+
UpdateMCPServerDTOFromJSON,
|
|
104
|
+
UpdateMCPServerDTOToJSON,
|
|
105
|
+
} from '../models/UpdateMCPServerDTO';
|
|
111
106
|
|
|
112
107
|
export interface ApiKeysGetRequest {
|
|
113
108
|
/**
|
|
@@ -145,25 +140,6 @@ export interface AttachMCPServerRequest {
|
|
|
145
140
|
applicationMCPServerDTO: ApplicationMCPServerDTO;
|
|
146
141
|
}
|
|
147
142
|
|
|
148
|
-
export interface CallMCPServerToolRequest {
|
|
149
|
-
/**
|
|
150
|
-
* MCP Server ID
|
|
151
|
-
*/
|
|
152
|
-
mcpServerId: string;
|
|
153
|
-
/**
|
|
154
|
-
* Tool name to call
|
|
155
|
-
*/
|
|
156
|
-
toolName: string;
|
|
157
|
-
/**
|
|
158
|
-
*
|
|
159
|
-
*/
|
|
160
|
-
callMCPServerToolDTO: CallMCPServerToolDTO;
|
|
161
|
-
/**
|
|
162
|
-
* Downstream authorization token for the MCP server
|
|
163
|
-
*/
|
|
164
|
-
xDownstreamAuthorization?: string;
|
|
165
|
-
}
|
|
166
|
-
|
|
167
143
|
export interface CreateAccountRequest {
|
|
168
144
|
/**
|
|
169
145
|
*
|
|
@@ -288,15 +264,19 @@ export interface GetMCPServersByApplicationRequest {
|
|
|
288
264
|
pageSize?: number;
|
|
289
265
|
}
|
|
290
266
|
|
|
291
|
-
export interface
|
|
267
|
+
export interface SearchApplicationToolsRequest {
|
|
292
268
|
/**
|
|
293
|
-
*
|
|
269
|
+
* Application ID
|
|
294
270
|
*/
|
|
295
|
-
|
|
271
|
+
applicationId: string;
|
|
296
272
|
/**
|
|
297
|
-
*
|
|
273
|
+
* Search query
|
|
298
274
|
*/
|
|
299
|
-
|
|
275
|
+
query: string;
|
|
276
|
+
/**
|
|
277
|
+
* Role to simulate; when omitted no role filtering is applied
|
|
278
|
+
*/
|
|
279
|
+
role?: string;
|
|
300
280
|
}
|
|
301
281
|
|
|
302
282
|
export interface UpdateApplicationRequest {
|
|
@@ -310,6 +290,17 @@ export interface UpdateApplicationRequest {
|
|
|
310
290
|
updateApplicationDTO: UpdateApplicationDTO;
|
|
311
291
|
}
|
|
312
292
|
|
|
293
|
+
export interface UpdateMCPServerRequest {
|
|
294
|
+
/**
|
|
295
|
+
* MCP Server ID
|
|
296
|
+
*/
|
|
297
|
+
mcpServerId: string;
|
|
298
|
+
/**
|
|
299
|
+
*
|
|
300
|
+
*/
|
|
301
|
+
updateMCPServerDTO: UpdateMCPServerDTO;
|
|
302
|
+
}
|
|
303
|
+
|
|
313
304
|
/**
|
|
314
305
|
*
|
|
315
306
|
*/
|
|
@@ -513,75 +504,6 @@ export class ClientApi extends runtime.BaseAPI {
|
|
|
513
504
|
await this.attachMCPServerRaw(requestParameters, initOverrides);
|
|
514
505
|
}
|
|
515
506
|
|
|
516
|
-
/**
|
|
517
|
-
* Creates request options for callMCPServerTool without sending the request
|
|
518
|
-
*/
|
|
519
|
-
async callMCPServerToolRequestOpts(requestParameters: CallMCPServerToolRequest): Promise<runtime.RequestOpts> {
|
|
520
|
-
if (requestParameters['mcpServerId'] == null) {
|
|
521
|
-
throw new runtime.RequiredError(
|
|
522
|
-
'mcpServerId',
|
|
523
|
-
'Required parameter "mcpServerId" was null or undefined when calling callMCPServerTool().'
|
|
524
|
-
);
|
|
525
|
-
}
|
|
526
|
-
|
|
527
|
-
if (requestParameters['toolName'] == null) {
|
|
528
|
-
throw new runtime.RequiredError(
|
|
529
|
-
'toolName',
|
|
530
|
-
'Required parameter "toolName" was null or undefined when calling callMCPServerTool().'
|
|
531
|
-
);
|
|
532
|
-
}
|
|
533
|
-
|
|
534
|
-
if (requestParameters['callMCPServerToolDTO'] == null) {
|
|
535
|
-
throw new runtime.RequiredError(
|
|
536
|
-
'callMCPServerToolDTO',
|
|
537
|
-
'Required parameter "callMCPServerToolDTO" was null or undefined when calling callMCPServerTool().'
|
|
538
|
-
);
|
|
539
|
-
}
|
|
540
|
-
|
|
541
|
-
const queryParameters: any = {};
|
|
542
|
-
|
|
543
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
544
|
-
|
|
545
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
546
|
-
|
|
547
|
-
if (requestParameters['xDownstreamAuthorization'] != null) {
|
|
548
|
-
headerParameters['X-Downstream-Authorization'] = String(requestParameters['xDownstreamAuthorization']);
|
|
549
|
-
}
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
let urlPath = `/mcp-servers/{mcpServerId}/tools/{toolName}/executions`;
|
|
553
|
-
urlPath = urlPath.replace('{mcpServerId}', encodeURIComponent(String(requestParameters['mcpServerId'])));
|
|
554
|
-
urlPath = urlPath.replace('{toolName}', encodeURIComponent(String(requestParameters['toolName'])));
|
|
555
|
-
|
|
556
|
-
return {
|
|
557
|
-
path: urlPath,
|
|
558
|
-
method: 'POST',
|
|
559
|
-
headers: headerParameters,
|
|
560
|
-
query: queryParameters,
|
|
561
|
-
body: CallMCPServerToolDTOToJSON(requestParameters['callMCPServerToolDTO']),
|
|
562
|
-
};
|
|
563
|
-
}
|
|
564
|
-
|
|
565
|
-
/**
|
|
566
|
-
* Send a JSON-RPC tools/call request to a deployed MCP server and return its result
|
|
567
|
-
* Call a tool of an MCP server
|
|
568
|
-
*/
|
|
569
|
-
async callMCPServerToolRaw(requestParameters: CallMCPServerToolRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CallMCPServerToolResultDTO>> {
|
|
570
|
-
const requestOptions = await this.callMCPServerToolRequestOpts(requestParameters);
|
|
571
|
-
const response = await this.request(requestOptions, initOverrides);
|
|
572
|
-
|
|
573
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => CallMCPServerToolResultDTOFromJSON(jsonValue));
|
|
574
|
-
}
|
|
575
|
-
|
|
576
|
-
/**
|
|
577
|
-
* Send a JSON-RPC tools/call request to a deployed MCP server and return its result
|
|
578
|
-
* Call a tool of an MCP server
|
|
579
|
-
*/
|
|
580
|
-
async callMCPServerTool(requestParameters: CallMCPServerToolRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CallMCPServerToolResultDTO> {
|
|
581
|
-
const response = await this.callMCPServerToolRaw(requestParameters, initOverrides);
|
|
582
|
-
return await response.value();
|
|
583
|
-
}
|
|
584
|
-
|
|
585
507
|
/**
|
|
586
508
|
* Creates request options for createAccount without sending the request
|
|
587
509
|
*/
|
|
@@ -1225,27 +1147,38 @@ export class ClientApi extends runtime.BaseAPI {
|
|
|
1225
1147
|
}
|
|
1226
1148
|
|
|
1227
1149
|
/**
|
|
1228
|
-
* Creates request options for
|
|
1150
|
+
* Creates request options for searchApplicationTools without sending the request
|
|
1229
1151
|
*/
|
|
1230
|
-
async
|
|
1231
|
-
if (requestParameters['
|
|
1152
|
+
async searchApplicationToolsRequestOpts(requestParameters: SearchApplicationToolsRequest): Promise<runtime.RequestOpts> {
|
|
1153
|
+
if (requestParameters['applicationId'] == null) {
|
|
1232
1154
|
throw new runtime.RequiredError(
|
|
1233
|
-
'
|
|
1234
|
-
'Required parameter "
|
|
1155
|
+
'applicationId',
|
|
1156
|
+
'Required parameter "applicationId" was null or undefined when calling searchApplicationTools().'
|
|
1157
|
+
);
|
|
1158
|
+
}
|
|
1159
|
+
|
|
1160
|
+
if (requestParameters['query'] == null) {
|
|
1161
|
+
throw new runtime.RequiredError(
|
|
1162
|
+
'query',
|
|
1163
|
+
'Required parameter "query" was null or undefined when calling searchApplicationTools().'
|
|
1235
1164
|
);
|
|
1236
1165
|
}
|
|
1237
1166
|
|
|
1238
1167
|
const queryParameters: any = {};
|
|
1239
1168
|
|
|
1240
|
-
|
|
1169
|
+
if (requestParameters['query'] != null) {
|
|
1170
|
+
queryParameters['query'] = requestParameters['query'];
|
|
1171
|
+
}
|
|
1241
1172
|
|
|
1242
|
-
if (requestParameters['
|
|
1243
|
-
|
|
1173
|
+
if (requestParameters['role'] != null) {
|
|
1174
|
+
queryParameters['role'] = requestParameters['role'];
|
|
1244
1175
|
}
|
|
1245
1176
|
|
|
1177
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1246
1178
|
|
|
1247
|
-
|
|
1248
|
-
urlPath =
|
|
1179
|
+
|
|
1180
|
+
let urlPath = `/applications/{applicationId}/tools-search`;
|
|
1181
|
+
urlPath = urlPath.replace('{applicationId}', encodeURIComponent(String(requestParameters['applicationId'])));
|
|
1249
1182
|
|
|
1250
1183
|
return {
|
|
1251
1184
|
path: urlPath,
|
|
@@ -1256,22 +1189,22 @@ export class ClientApi extends runtime.BaseAPI {
|
|
|
1256
1189
|
}
|
|
1257
1190
|
|
|
1258
1191
|
/**
|
|
1259
|
-
*
|
|
1260
|
-
*
|
|
1192
|
+
* Lists the tools of the application\'s MCP servers, applies role filtering and ranks them against the query with BM25 and a fuzzy fallback. Intended for tuning search quality: no session is created and nothing is cached.
|
|
1193
|
+
* Search an application\'s MCP tools (debug)
|
|
1261
1194
|
*/
|
|
1262
|
-
async
|
|
1263
|
-
const requestOptions = await this.
|
|
1195
|
+
async searchApplicationToolsRaw(requestParameters: SearchApplicationToolsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchToolsResponseDTO>> {
|
|
1196
|
+
const requestOptions = await this.searchApplicationToolsRequestOpts(requestParameters);
|
|
1264
1197
|
const response = await this.request(requestOptions, initOverrides);
|
|
1265
1198
|
|
|
1266
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue
|
|
1199
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SearchToolsResponseDTOFromJSON(jsonValue));
|
|
1267
1200
|
}
|
|
1268
1201
|
|
|
1269
1202
|
/**
|
|
1270
|
-
*
|
|
1271
|
-
*
|
|
1203
|
+
* Lists the tools of the application\'s MCP servers, applies role filtering and ranks them against the query with BM25 and a fuzzy fallback. Intended for tuning search quality: no session is created and nothing is cached.
|
|
1204
|
+
* Search an application\'s MCP tools (debug)
|
|
1272
1205
|
*/
|
|
1273
|
-
async
|
|
1274
|
-
const response = await this.
|
|
1206
|
+
async searchApplicationTools(requestParameters: SearchApplicationToolsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchToolsResponseDTO> {
|
|
1207
|
+
const response = await this.searchApplicationToolsRaw(requestParameters, initOverrides);
|
|
1275
1208
|
return await response.value();
|
|
1276
1209
|
}
|
|
1277
1210
|
|
|
@@ -1332,6 +1265,63 @@ export class ClientApi extends runtime.BaseAPI {
|
|
|
1332
1265
|
return await response.value();
|
|
1333
1266
|
}
|
|
1334
1267
|
|
|
1268
|
+
/**
|
|
1269
|
+
* Creates request options for updateMCPServer without sending the request
|
|
1270
|
+
*/
|
|
1271
|
+
async updateMCPServerRequestOpts(requestParameters: UpdateMCPServerRequest): Promise<runtime.RequestOpts> {
|
|
1272
|
+
if (requestParameters['mcpServerId'] == null) {
|
|
1273
|
+
throw new runtime.RequiredError(
|
|
1274
|
+
'mcpServerId',
|
|
1275
|
+
'Required parameter "mcpServerId" was null or undefined when calling updateMCPServer().'
|
|
1276
|
+
);
|
|
1277
|
+
}
|
|
1278
|
+
|
|
1279
|
+
if (requestParameters['updateMCPServerDTO'] == null) {
|
|
1280
|
+
throw new runtime.RequiredError(
|
|
1281
|
+
'updateMCPServerDTO',
|
|
1282
|
+
'Required parameter "updateMCPServerDTO" was null or undefined when calling updateMCPServer().'
|
|
1283
|
+
);
|
|
1284
|
+
}
|
|
1285
|
+
|
|
1286
|
+
const queryParameters: any = {};
|
|
1287
|
+
|
|
1288
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1289
|
+
|
|
1290
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
let urlPath = `/mcp-servers/{mcpServerId}`;
|
|
1294
|
+
urlPath = urlPath.replace('{mcpServerId}', encodeURIComponent(String(requestParameters['mcpServerId'])));
|
|
1295
|
+
|
|
1296
|
+
return {
|
|
1297
|
+
path: urlPath,
|
|
1298
|
+
method: 'PATCH',
|
|
1299
|
+
headers: headerParameters,
|
|
1300
|
+
query: queryParameters,
|
|
1301
|
+
body: UpdateMCPServerDTOToJSON(requestParameters['updateMCPServerDTO']),
|
|
1302
|
+
};
|
|
1303
|
+
}
|
|
1304
|
+
|
|
1305
|
+
/**
|
|
1306
|
+
* Update an existing MCP server for the authenticated account
|
|
1307
|
+
* Update an existing MCP server
|
|
1308
|
+
*/
|
|
1309
|
+
async updateMCPServerRaw(requestParameters: UpdateMCPServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MCPServerDTO>> {
|
|
1310
|
+
const requestOptions = await this.updateMCPServerRequestOpts(requestParameters);
|
|
1311
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1312
|
+
|
|
1313
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => MCPServerDTOFromJSON(jsonValue));
|
|
1314
|
+
}
|
|
1315
|
+
|
|
1316
|
+
/**
|
|
1317
|
+
* Update an existing MCP server for the authenticated account
|
|
1318
|
+
* Update an existing MCP server
|
|
1319
|
+
*/
|
|
1320
|
+
async updateMCPServer(requestParameters: UpdateMCPServerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MCPServerDTO> {
|
|
1321
|
+
const response = await this.updateMCPServerRaw(requestParameters, initOverrides);
|
|
1322
|
+
return await response.value();
|
|
1323
|
+
}
|
|
1324
|
+
|
|
1335
1325
|
}
|
|
1336
1326
|
|
|
1337
1327
|
/**
|
package/docs/ClientApi.md
CHANGED
|
@@ -8,7 +8,6 @@ All URIs are relative to *http://localhost:3000*
|
|
|
8
8
|
| [**apiKeysIdDelete**](ClientApi.md#apikeysiddelete) | **DELETE** /api-keys/{id} | Delete an API key |
|
|
9
9
|
| [**apiKeysPost**](ClientApi.md#apikeyspost) | **POST** /api-keys | Create a new API key |
|
|
10
10
|
| [**attachMCPServer**](ClientApi.md#attachmcpserver) | **POST** /applications/{applicationId}/mcp-servers | Attach MCP server to application |
|
|
11
|
-
| [**callMCPServerTool**](ClientApi.md#callmcpservertool) | **POST** /mcp-servers/{mcpServerId}/tools/{toolName}/executions | Call a tool of an MCP server |
|
|
12
11
|
| [**createAccount**](ClientApi.md#createaccount) | **POST** /accounts | Creates a new account |
|
|
13
12
|
| [**createApplication**](ClientApi.md#createapplication) | **POST** /applications | Create a new application |
|
|
14
13
|
| [**createMCPServer**](ClientApi.md#createmcpserver) | **POST** /mcp-servers | Create a new MCP server |
|
|
@@ -22,8 +21,9 @@ All URIs are relative to *http://localhost:3000*
|
|
|
22
21
|
| [**getMCPServerStatus**](ClientApi.md#getmcpserverstatus) | **GET** /mcp-servers/{mcpServerId}/status | Get MCP server generation status |
|
|
23
22
|
| [**getMCPServers**](ClientApi.md#getmcpservers) | **GET** /mcp-servers | List MCP servers for account |
|
|
24
23
|
| [**getMCPServersByApplication**](ClientApi.md#getmcpserversbyapplication) | **GET** /applications/{applicationId}/mcp-servers | List MCP servers for an application |
|
|
25
|
-
| [**
|
|
24
|
+
| [**searchApplicationTools**](ClientApi.md#searchapplicationtools) | **GET** /applications/{applicationId}/tools-search | Search an application\'s MCP tools (debug) |
|
|
26
25
|
| [**updateApplication**](ClientApi.md#updateapplication) | **PATCH** /applications/{applicationId} | Update an application |
|
|
26
|
+
| [**updateMCPServer**](ClientApi.md#updatemcpserver) | **PATCH** /mcp-servers/{mcpServerId} | Update an existing MCP server |
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
|
|
@@ -317,88 +317,6 @@ No authorization required
|
|
|
317
317
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
318
318
|
|
|
319
319
|
|
|
320
|
-
## callMCPServerTool
|
|
321
|
-
|
|
322
|
-
> CallMCPServerToolResultDTO callMCPServerTool(mcpServerId, toolName, callMCPServerToolDTO, xDownstreamAuthorization)
|
|
323
|
-
|
|
324
|
-
Call a tool of an MCP server
|
|
325
|
-
|
|
326
|
-
Send a JSON-RPC tools/call request to a deployed MCP server and return its result
|
|
327
|
-
|
|
328
|
-
### Example
|
|
329
|
-
|
|
330
|
-
```ts
|
|
331
|
-
import {
|
|
332
|
-
Configuration,
|
|
333
|
-
ClientApi,
|
|
334
|
-
} from '';
|
|
335
|
-
import type { CallMCPServerToolRequest } from '';
|
|
336
|
-
|
|
337
|
-
async function example() {
|
|
338
|
-
console.log("🚀 Testing SDK...");
|
|
339
|
-
const api = new ClientApi();
|
|
340
|
-
|
|
341
|
-
const body = {
|
|
342
|
-
// string | MCP Server ID
|
|
343
|
-
mcpServerId: mcpServerId_example,
|
|
344
|
-
// string | Tool name to call
|
|
345
|
-
toolName: toolName_example,
|
|
346
|
-
// CallMCPServerToolDTO | Tool call data
|
|
347
|
-
callMCPServerToolDTO: ...,
|
|
348
|
-
// string | Downstream authorization token for the MCP server (optional)
|
|
349
|
-
xDownstreamAuthorization: xDownstreamAuthorization_example,
|
|
350
|
-
} satisfies CallMCPServerToolRequest;
|
|
351
|
-
|
|
352
|
-
try {
|
|
353
|
-
const data = await api.callMCPServerTool(body);
|
|
354
|
-
console.log(data);
|
|
355
|
-
} catch (error) {
|
|
356
|
-
console.error(error);
|
|
357
|
-
}
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
// Run the test
|
|
361
|
-
example().catch(console.error);
|
|
362
|
-
```
|
|
363
|
-
|
|
364
|
-
### Parameters
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
| Name | Type | Description | Notes |
|
|
368
|
-
|------------- | ------------- | ------------- | -------------|
|
|
369
|
-
| **mcpServerId** | `string` | MCP Server ID | [Defaults to `undefined`] |
|
|
370
|
-
| **toolName** | `string` | Tool name to call | [Defaults to `undefined`] |
|
|
371
|
-
| **callMCPServerToolDTO** | [CallMCPServerToolDTO](CallMCPServerToolDTO.md) | Tool call data | |
|
|
372
|
-
| **xDownstreamAuthorization** | `string` | Downstream authorization token for the MCP server | [Optional] [Defaults to `undefined`] |
|
|
373
|
-
|
|
374
|
-
### Return type
|
|
375
|
-
|
|
376
|
-
[**CallMCPServerToolResultDTO**](CallMCPServerToolResultDTO.md)
|
|
377
|
-
|
|
378
|
-
### Authorization
|
|
379
|
-
|
|
380
|
-
No authorization required
|
|
381
|
-
|
|
382
|
-
### HTTP request headers
|
|
383
|
-
|
|
384
|
-
- **Content-Type**: `application/json`
|
|
385
|
-
- **Accept**: `application/json`
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
### HTTP response details
|
|
389
|
-
| Status code | Description | Response headers |
|
|
390
|
-
|-------------|-------------|------------------|
|
|
391
|
-
| **200** | Tool call result | - |
|
|
392
|
-
| **400** | Bad Request | - |
|
|
393
|
-
| **401** | Unauthorized | - |
|
|
394
|
-
| **402** | Payment Required | - |
|
|
395
|
-
| **404** | Not Found | - |
|
|
396
|
-
| **500** | Internal Server Error | - |
|
|
397
|
-
| **502** | Bad Gateway | - |
|
|
398
|
-
|
|
399
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
400
|
-
|
|
401
|
-
|
|
402
320
|
## createAccount
|
|
403
321
|
|
|
404
322
|
> AccountDTO createAccount(createAccountDTO)
|
|
@@ -1351,13 +1269,13 @@ No authorization required
|
|
|
1351
1269
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1352
1270
|
|
|
1353
1271
|
|
|
1354
|
-
##
|
|
1272
|
+
## searchApplicationTools
|
|
1355
1273
|
|
|
1356
|
-
>
|
|
1274
|
+
> SearchToolsResponseDTO searchApplicationTools(applicationId, query, role)
|
|
1357
1275
|
|
|
1358
|
-
|
|
1276
|
+
Search an application\'s MCP tools (debug)
|
|
1359
1277
|
|
|
1360
|
-
|
|
1278
|
+
Lists the tools of the application\'s MCP servers, applies role filtering and ranks them against the query with BM25 and a fuzzy fallback. Intended for tuning search quality: no session is created and nothing is cached.
|
|
1361
1279
|
|
|
1362
1280
|
### Example
|
|
1363
1281
|
|
|
@@ -1366,21 +1284,23 @@ import {
|
|
|
1366
1284
|
Configuration,
|
|
1367
1285
|
ClientApi,
|
|
1368
1286
|
} from '';
|
|
1369
|
-
import type {
|
|
1287
|
+
import type { SearchApplicationToolsRequest } from '';
|
|
1370
1288
|
|
|
1371
1289
|
async function example() {
|
|
1372
1290
|
console.log("🚀 Testing SDK...");
|
|
1373
1291
|
const api = new ClientApi();
|
|
1374
1292
|
|
|
1375
1293
|
const body = {
|
|
1376
|
-
// string |
|
|
1377
|
-
|
|
1378
|
-
// string |
|
|
1379
|
-
|
|
1380
|
-
|
|
1294
|
+
// string | Application ID
|
|
1295
|
+
applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1296
|
+
// string | Search query
|
|
1297
|
+
query: query_example,
|
|
1298
|
+
// string | Role to simulate; when omitted no role filtering is applied (optional)
|
|
1299
|
+
role: role_example,
|
|
1300
|
+
} satisfies SearchApplicationToolsRequest;
|
|
1381
1301
|
|
|
1382
1302
|
try {
|
|
1383
|
-
const data = await api.
|
|
1303
|
+
const data = await api.searchApplicationTools(body);
|
|
1384
1304
|
console.log(data);
|
|
1385
1305
|
} catch (error) {
|
|
1386
1306
|
console.error(error);
|
|
@@ -1396,12 +1316,13 @@ example().catch(console.error);
|
|
|
1396
1316
|
|
|
1397
1317
|
| Name | Type | Description | Notes |
|
|
1398
1318
|
|------------- | ------------- | ------------- | -------------|
|
|
1399
|
-
| **
|
|
1400
|
-
| **
|
|
1319
|
+
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
|
|
1320
|
+
| **query** | `string` | Search query | [Defaults to `undefined`] |
|
|
1321
|
+
| **role** | `string` | Role to simulate; when omitted no role filtering is applied | [Optional] [Defaults to `undefined`] |
|
|
1401
1322
|
|
|
1402
1323
|
### Return type
|
|
1403
1324
|
|
|
1404
|
-
[**
|
|
1325
|
+
[**SearchToolsResponseDTO**](SearchToolsResponseDTO.md)
|
|
1405
1326
|
|
|
1406
1327
|
### Authorization
|
|
1407
1328
|
|
|
@@ -1416,13 +1337,12 @@ No authorization required
|
|
|
1416
1337
|
### HTTP response details
|
|
1417
1338
|
| Status code | Description | Response headers |
|
|
1418
1339
|
|-------------|-------------|------------------|
|
|
1419
|
-
| **200** |
|
|
1340
|
+
| **200** | Listed tools and ranked results | - |
|
|
1420
1341
|
| **400** | Bad Request | - |
|
|
1421
1342
|
| **401** | Unauthorized | - |
|
|
1422
1343
|
| **402** | Payment Required | - |
|
|
1423
1344
|
| **404** | Not Found | - |
|
|
1424
1345
|
| **500** | Internal Server Error | - |
|
|
1425
|
-
| **502** | Bad Gateway | - |
|
|
1426
1346
|
|
|
1427
1347
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1428
1348
|
|
|
@@ -1502,3 +1422,77 @@ No authorization required
|
|
|
1502
1422
|
|
|
1503
1423
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1504
1424
|
|
|
1425
|
+
|
|
1426
|
+
## updateMCPServer
|
|
1427
|
+
|
|
1428
|
+
> MCPServerDTO updateMCPServer(mcpServerId, updateMCPServerDTO)
|
|
1429
|
+
|
|
1430
|
+
Update an existing MCP server
|
|
1431
|
+
|
|
1432
|
+
Update an existing MCP server for the authenticated account
|
|
1433
|
+
|
|
1434
|
+
### Example
|
|
1435
|
+
|
|
1436
|
+
```ts
|
|
1437
|
+
import {
|
|
1438
|
+
Configuration,
|
|
1439
|
+
ClientApi,
|
|
1440
|
+
} from '';
|
|
1441
|
+
import type { UpdateMCPServerRequest } from '';
|
|
1442
|
+
|
|
1443
|
+
async function example() {
|
|
1444
|
+
console.log("🚀 Testing SDK...");
|
|
1445
|
+
const api = new ClientApi();
|
|
1446
|
+
|
|
1447
|
+
const body = {
|
|
1448
|
+
// string | MCP Server ID
|
|
1449
|
+
mcpServerId: mcpServerId_example,
|
|
1450
|
+
// UpdateMCPServerDTO | MCP server update data
|
|
1451
|
+
updateMCPServerDTO: ...,
|
|
1452
|
+
} satisfies UpdateMCPServerRequest;
|
|
1453
|
+
|
|
1454
|
+
try {
|
|
1455
|
+
const data = await api.updateMCPServer(body);
|
|
1456
|
+
console.log(data);
|
|
1457
|
+
} catch (error) {
|
|
1458
|
+
console.error(error);
|
|
1459
|
+
}
|
|
1460
|
+
}
|
|
1461
|
+
|
|
1462
|
+
// Run the test
|
|
1463
|
+
example().catch(console.error);
|
|
1464
|
+
```
|
|
1465
|
+
|
|
1466
|
+
### Parameters
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
| Name | Type | Description | Notes |
|
|
1470
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1471
|
+
| **mcpServerId** | `string` | MCP Server ID | [Defaults to `undefined`] |
|
|
1472
|
+
| **updateMCPServerDTO** | [UpdateMCPServerDTO](UpdateMCPServerDTO.md) | MCP server update data | |
|
|
1473
|
+
|
|
1474
|
+
### Return type
|
|
1475
|
+
|
|
1476
|
+
[**MCPServerDTO**](MCPServerDTO.md)
|
|
1477
|
+
|
|
1478
|
+
### Authorization
|
|
1479
|
+
|
|
1480
|
+
No authorization required
|
|
1481
|
+
|
|
1482
|
+
### HTTP request headers
|
|
1483
|
+
|
|
1484
|
+
- **Content-Type**: `application/json`
|
|
1485
|
+
- **Accept**: `application/json`
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
### HTTP response details
|
|
1489
|
+
| Status code | Description | Response headers |
|
|
1490
|
+
|-------------|-------------|------------------|
|
|
1491
|
+
| **200** | Updated MCP server | - |
|
|
1492
|
+
| **400** | Bad Request | - |
|
|
1493
|
+
| **401** | Unauthorized | - |
|
|
1494
|
+
| **402** | Payment Required | - |
|
|
1495
|
+
| **500** | Internal Server Error | - |
|
|
1496
|
+
|
|
1497
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1498
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# SearchToolsResponseDTO
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`availableTools` | [Array<ToolDTO>](ToolDTO.md)
|
|
10
|
+
`failedServers` | Array<string>
|
|
11
|
+
`note` | string
|
|
12
|
+
`query` | string
|
|
13
|
+
`results` | [Array<ToolMatchDTO>](ToolMatchDTO.md)
|
|
14
|
+
`role` | string
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { SearchToolsResponseDTO } from ''
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"availableTools": null,
|
|
24
|
+
"failedServers": null,
|
|
25
|
+
"note": null,
|
|
26
|
+
"query": null,
|
|
27
|
+
"results": null,
|
|
28
|
+
"role": null,
|
|
29
|
+
} satisfies SearchToolsResponseDTO
|
|
30
|
+
|
|
31
|
+
console.log(example)
|
|
32
|
+
|
|
33
|
+
// Convert the instance to a JSON string
|
|
34
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
35
|
+
console.log(exampleJSON)
|
|
36
|
+
|
|
37
|
+
// Parse the JSON string back to an object
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as SearchToolsResponseDTO
|
|
39
|
+
console.log(exampleParsed)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
43
|
+
|
|
44
|
+
|