Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 | 5x 5x 7x 5x 5x 5x 5x 5x 3x 3x 2x 8x 6x 6x 8x 8x 8x 8x 8x 18x 9x 9x 9x 8x 8x 8x 8x 8x 5x 5x 3x 3x 3x 2x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 6x 7x 7x 1x 6x 3x 1x 2x 2x 1x 9x 182x 8x 3x 10x 10x 85x 5x 5x 3x 3x 3x 80x 9x 9x 7x 7x 7x 85x 5x 80x 71x 9x 90x 90x 2x 88x 90x 1x 87x 87x 90x 90x 90x 90x 90x 90x 90x 90x 90x 90x 90x 90x 90x 2x 85x 90x 90x 90x 85x 85x 84x 84x 84x 84x 84x 84x 84x 85x 90x 9x 7x 3x 7x 7x 7x 8x 8x 9x 9x 9x 9x 9x 9x 9x 9x 9x 3x 3x 3x 9x 9x 9x 9x 9x 9x 9x 9x 9x 2x 7x 7x 7x 7x 7x 7x 7x 26x 26x 18x 8x 8x 8x 7x 7x 26x 7x 2x 25x 5x 9x 1x 4x 4x 4x 17x 17x 12x 5x 5x 4x 5x 24x 4x 1x 4x 1x 3x 2x 2x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 4x 4x 4x 4x 4x 4x 16x 24x 4x 4x 16x 16x 16x 4x 70x 70x 70x 70x 8x 62x 23x 30x 30x 30x 23x 23x 23x 39x 62x 62x 62x 62x 62x 69x 69x 69x 69x 69x 69x 151x 69x 62x 62x 4x 3x 11x 62x 7x 31x 62x 31x 31x 31x 69x 15x 54x 69x 69x 69x 69x 54x 54x 151x 151x 151x 151x 20x 20x 1x 19x 20x 20x 20x 20x 20x 20x 20x 20x 20x 20x 23x 19x 4x 18x 13x 13x 5x 5x 2x 1x 1x 151x 18x 36x 18x 18x 72x 72x 19x 53x | import { defu } from 'defu';
import type { MergeExclusive, SimplifyDeep } from 'type-fest';
import { z } from 'zod/v4';
import { DEFAULT_BASE_URL } from './consts';
import { createFeedbackTool } from './feedback';
import { type StackOneHeaders, normalizeHeaders, stackOneHeadersSchema } from './headers';
import { ToolIndex } from './local-search';
import { createMCPClient } from './mcp-client';
import { type RpcActionResponse, RpcClient } from './rpc-client';
import {
SemanticSearchClient,
SemanticSearchError,
type SemanticSearchResult,
} from './semantic-search';
import { BaseTool, Tools } from './tool';
import type {
DefenderConfig,
DefenderMode,
ExecuteOptions,
JsonObject,
JsonSchemaProperties,
LocalExecuteConfig,
RpcExecuteConfig,
SearchConfig,
ToolParameters,
} from './types';
import { DEFAULT_DEFENDER_CONFIG } from './types';
import { StackOneError } from './utils/error-stackone';
import { StackOneAPIError } from './utils/error-stackone-api';
import { normalizeActionName } from './utils/normalize';
/**
* Converts RpcActionResponse to JsonObject in a type-safe manner.
* RpcActionResponse uses z.passthrough() which preserves additional fields,
* making it structurally compatible with Record<string, JsonValue>.
*/
function rpcResponseToJsonObject(response: RpcActionResponse): JsonObject {
// RpcActionResponse with passthrough() has the shape:
// { next?: string | null, data?: ..., [key: string]: unknown }
// We extract all properties into a plain object
const result: JsonObject = {};
for (const [key, value] of Object.entries(response)) {
result[key] = value as JsonObject[string];
}
return result;
}
type ToolInputSchema = Awaited<
ReturnType<Awaited<ReturnType<typeof createMCPClient>>['client']['listTools']>
>['tools'][number]['inputSchema'];
/**
* Base exception for toolset errors
*/
export class ToolSetError extends Error {
constructor(message: string, options?: ErrorOptions) {
super(message, options);
this.name = 'ToolSetError';
}
}
/**
* Raised when there is an error in the toolset configuration
*/
export class ToolSetConfigError extends ToolSetError {
constructor(message: string, options?: ErrorOptions) {
super(message, options);
this.name = 'ToolSetConfigError';
}
}
/**
* Raised when there is an error loading tools
*/
export class ToolSetLoadError extends ToolSetError {
constructor(message: string, options?: ErrorOptions) {
super(message, options);
this.name = 'ToolSetLoadError';
}
}
/**
* Authentication configuration for toolsets
*/
export interface AuthenticationConfig {
type: 'basic' | 'bearer';
credentials?: {
username?: string;
password?: string;
token?: string;
};
headers?: Record<string, string>;
}
/**
* Base configuration for all toolsets
*/
export interface BaseToolSetConfig {
baseUrl?: string;
authentication?: AuthenticationConfig;
headers?: Record<string, string>;
rpcClient?: RpcClient;
/** Request timeout in milliseconds. Default: 60000 (60s). */
timeout?: number;
}
/**
* Configuration with a single account ID
*/
interface SingleAccountConfig {
/**
* Single account ID for StackOne API operations
* Use this when working with a single account
*/
accountId: string;
}
/**
* Configuration with multiple account IDs
*/
interface MultipleAccountsConfig {
/**
* Array of account IDs for filtering tools across multiple accounts
* When provided, tools will be fetched for all specified accounts
* @example ['account-1', 'account-2']
*/
accountIds: string[];
}
/**
* Account configuration options - either single accountId or multiple accountIds, but not both
*/
type AccountConfig = SimplifyDeep<MergeExclusive<SingleAccountConfig, MultipleAccountsConfig>>;
/**
* Execution configuration for the StackOneToolSet constructor.
* Controls default account scoping for tool execution in tools.
*/
export interface ExecuteToolsConfig {
/** Account IDs to scope tool discovery and execution. */
accountIds?: string[];
/** Request timeout in milliseconds. Can also be set as a top-level config param which takes precedence. */
timeout?: number;
}
/**
* Base configuration for StackOne toolset (without account options)
*/
interface StackOneToolSetBaseConfig extends BaseToolSetConfig {
apiKey?: string;
strict?: boolean;
/**
* Search configuration. Controls default search behavior for `searchTools()`,
* `getSearchTool()`, and `searchActionNames()`.
*
* - Omit or pass `undefined` → search disabled (`null`)
* - Pass `null` → search disabled
* - Pass `{}` or `{ method: 'auto' }` → search enabled with defaults
* - Pass `{ method, topK, minSimilarity }` → search enabled with custom defaults
*
* Per-call options always override these defaults.
*/
search?: SearchConfig | null;
/**
* Execution configuration. Controls default account scoping for tool execution.
* Pass `{ accountIds: ['acc-1'] }` to scope tools to specific accounts.
*/
execute?: ExecuteToolsConfig;
/**
* Defender configuration. Controls prompt injection detection behavior for all tool calls.
*
* - Omit or pass `undefined` (default) → defer to the project dashboard setting
* - Pass `{ useProjectSettings: true }` → same as omitting; explicit form of the default
* - Pass `{ enabled, blockHighRisk, ... }` → explicit SDK-level config, overrides project settings
* - Pass `null` → defender explicitly disabled, overrides project settings
*/
defender?: DefenderConfig | null;
}
/**
* Configuration for StackOne toolset
* Accepts either accountId (single) or accountIds (multiple), but not both
*/
export type StackOneToolSetConfig = StackOneToolSetBaseConfig & Partial<AccountConfig>;
/**
* Options for filtering tools when fetching from MCP
*/
interface FetchToolsOptions {
/**
* Filter tools by account IDs
* Only tools available on these accounts will be returned
*/
accountIds?: string[];
/**
* Filter tools by provider names
* Only tools from these providers will be returned
* @example ['hibob', 'bamboohr']
*/
providers?: string[];
/**
* Filter tools by action patterns with glob support
* Only tools matching these patterns will be returned
* @example ['*_list_employees', 'hibob_create_employees']
*/
actions?: string[];
}
/**
* Search mode for tool discovery.
*
* - `"auto"` (default): try semantic search first, fall back to local BM25+TF-IDF if the API is unavailable
* - `"semantic"`: use only the semantic search API; throws SemanticSearchError on failure
* - `"local"`: use only local BM25+TF-IDF search (no API call to the semantic search endpoint)
*/
export type SearchMode = 'auto' | 'semantic' | 'local';
/**
* Options for searchTools() and SearchTool
*/
export interface SearchToolsOptions {
/** Optional provider/connector filter (e.g., "bamboohr", "slack") */
connector?: string;
/** Maximum number of tools to return */
topK?: number;
/** Minimum similarity score threshold 0-1 */
minSimilarity?: number;
/** Optional account IDs (uses setAccounts() if not provided) */
accountIds?: string[];
/** Search backend to use */
search?: SearchMode;
}
/**
* Options for searchActionNames()
*/
export interface SearchActionNamesOptions {
/** Optional provider/connector filter */
connector?: string;
/** Optional account IDs to scope results */
accountIds?: string[];
/** Maximum number of results */
topK?: number;
/** Minimum similarity score threshold 0-1 */
minSimilarity?: number;
}
/**
* Callable search tool that wraps StackOneToolSet.searchTools().
*
* Designed for agent loops — call `search()` with a query to get Tools back.
*
* @example
* ```typescript
* const toolset = new StackOneToolSet({ apiKey: 'sk-xxx' });
* const searchTool = toolset.getSearchTool();
* const tools = await searchTool.search('manage employee records', { accountIds: ['acc-123'] });
* ```
*/
export class SearchTool {
private readonly toolset: StackOneToolSet;
private readonly defaultConfig: SearchConfig;
constructor(toolset: StackOneToolSet, config: SearchConfig = {}) {
this.toolset = toolset;
this.defaultConfig = config;
}
/**
* Search for tools using natural language.
*
* @param query - Natural language description of needed functionality
* @param options - Search options (connector, topK, minSimilarity, accountIds, search).
* Per-call options override the defaults from the constructor config.
* @returns Tools collection with matched tools
*/
async search(query: string, options?: SearchToolsOptions): Promise<Tools> {
return this.toolset.searchTools(query, {
...options,
search: options?.search ?? this.defaultConfig.method,
topK: options?.topK ?? this.defaultConfig.topK,
minSimilarity: options?.minSimilarity ?? this.defaultConfig.minSimilarity,
});
}
}
// --- Internal tool_search + tool_execute ---
const searchInputSchema = z.object({
query: z
.string()
.transform((v) => v.trim())
.refine((v) => v.length > 0, { message: 'query must be a non-empty string' }),
connector: z.string().optional(),
top_k: z.number().int().min(1).max(50).optional(),
});
const searchParameters = {
type: 'object',
properties: {
query: {
type: 'string',
description:
'Natural language description of what you need (e.g. "create an employee", "list time off requests")',
},
connector: {
type: 'string',
description: 'Optional connector filter (e.g. "bamboohr", "hibob")',
},
top_k: {
type: 'integer',
description: 'Max results to return (1-50, default 5)',
minimum: 1,
maximum: 50,
},
},
required: ['query'],
} as const satisfies ToolParameters;
const executeInputSchema = z.object({
tool_name: z
.string()
.transform((v) => v.trim())
.refine((v) => v.length > 0, { message: 'tool_name must be a non-empty string' }),
parameters: z.record(z.string(), z.unknown()).optional().default({}),
});
const executeParameters = {
type: 'object',
properties: {
tool_name: {
type: 'string',
description: 'Exact tool name from tool_search results',
},
parameters: {
type: 'object',
description: 'Parameters for the tool. Pass an empty object {} if no parameters are needed.',
},
},
required: ['tool_name'],
} as const satisfies ToolParameters;
const localConfig = (id: string): LocalExecuteConfig => ({
kind: 'local',
identifier: `meta:${id}`,
});
/** @internal */
export function createSearchTool(
toolset: StackOneToolSet,
accountIds?: string[],
connectors?: string,
): BaseTool {
const connectorLine = connectors ? ` Available connectors: ${connectors}.` : '';
const tool = new BaseTool(
'tool_search',
`Search for available tools by describing what you need. Returns matching tool names, descriptions, and parameter schemas. Use the returned parameter schemas to know exactly what to pass when calling tool_execute.${connectorLine}`,
searchParameters,
localConfig('search'),
);
tool.execute = async (inputParams?: JsonObject | string): Promise<JsonObject> => {
try {
const raw = typeof inputParams === 'string' ? JSON.parse(inputParams) : inputParams || {};
const parsed = searchInputSchema.parse(raw);
const searchConfig = toolset.getSearchConfig() ?? {};
const results = await toolset.searchTools(parsed.query, {
connector: parsed.connector,
topK: parsed.top_k ?? searchConfig.topK,
minSimilarity: searchConfig.minSimilarity,
search: searchConfig.method,
accountIds,
});
return {
tools: results.toArray().map((t) => ({
name: t.name,
description: t.description,
parameters: t.parameters.properties as unknown as JsonObject,
})),
total: results.length,
query: parsed.query,
};
} catch (error) {
Iif (error instanceof StackOneAPIError) {
return { error: error.message, status_code: error.statusCode };
}
Eif (error instanceof SyntaxError || error instanceof z.ZodError) {
return {
error: `Invalid input: ${error instanceof z.ZodError ? error.issues.map((i) => i.message).join(', ') : error.message}`,
};
}
throw error;
}
};
return tool;
}
/** @internal */
export function createExecuteTool(
toolset: StackOneToolSet,
accountIds?: string[],
connectors?: string,
): BaseTool {
let cachedTools: Awaited<ReturnType<typeof toolset.fetchTools>> | null = null;
const connectorLine = connectors ? ` Available connectors: ${connectors}.` : '';
const tool = new BaseTool(
'tool_execute',
`Execute a tool by name with the given parameters. Use tool_search first to find available tools. The parameters field must match the parameter schema returned by tool_search. Pass parameters as a nested object matching the schema structure.${connectorLine}`,
executeParameters,
localConfig('execute'),
);
tool.execute = async (
inputParams?: JsonObject | string,
executeOptions?: ExecuteOptions,
): Promise<JsonObject> => {
let toolName = 'unknown';
try {
const raw = typeof inputParams === 'string' ? JSON.parse(inputParams) : inputParams || {};
const parsed = executeInputSchema.parse(raw);
toolName = parsed.tool_name;
if (!cachedTools) {
cachedTools = await toolset.fetchTools({ accountIds });
}
const target = cachedTools.getTool(parsed.tool_name);
if (!target) {
return {
error: `Tool "${parsed.tool_name}" not found. Use tool_search to find available tools.`,
};
}
return await target.execute(parsed.parameters as JsonObject, executeOptions);
} catch (error) {
if (error instanceof StackOneAPIError) {
return {
error: error.message,
status_code: error.statusCode,
response_body: error.responseBody as JsonObject,
tool_name: toolName,
};
}
Eif (error instanceof SyntaxError || error instanceof z.ZodError) {
return {
error: `Invalid input: ${error instanceof z.ZodError ? error.issues.map((i) => i.message).join(', ') : error.message}`,
tool_name: toolName,
};
}
throw error;
}
};
return tool;
}
/** Wire-format defender config sent to the backend RPC action. */
interface DefenderApiConfig {
enabled: boolean;
block_high_risk: boolean;
use_tier1_classification: boolean;
use_tier2_classification: boolean;
}
/** Type guard: discriminate the `useProjectSettings: true` variant of DefenderConfig. */
function usesProjectSettings(config: DefenderConfig): config is { useProjectSettings: true } {
return 'useProjectSettings' in config && config.useProjectSettings === true;
}
/**
* Shapes already logged this process, keyed by mode + serialized wire payload.
* Ensures we surface one warning per distinct override shape, not per construction.
*/
const loggedDefenderShapes = new Set<string>();
/**
* Test-only: clear the once-per-process dedupe cache for defender override warnings.
* @internal
*/
export function __resetDefenderInfoLog(): void {
loggedDefenderShapes.clear();
}
/** Wrap text in yellow ANSI, only when stderr is a TTY and color isn't suppressed. */
function colorizeOverrideWarning(text: string): string {
Iif (process.env.NO_COLOR) return text;
Eif (!process.env.FORCE_COLOR && !process.stderr.isTTY) return text;
return `\x1b[33m${text}\x1b[0m`;
}
/**
* Warn once when the SDK overrides the project dashboard's defender setting.
* Silent for `project` mode (no override) and for repeat constructions with the same shape.
*/
function logDefenderOverride(
config: DefenderConfig | null,
wireFields: { defender_config: DefenderApiConfig } | Record<string, never>,
): void {
if (config === null) {
const key = 'disabled';
if (loggedDefenderShapes.has(key)) return;
loggedDefenderShapes.add(key);
console.warn(
colorizeOverrideWarning(
'Defender forcibly disabled via SDK config; project dashboard setting will be ignored.',
),
);
return;
}
if (usesProjectSettings(config)) return;
const key = `explicit:${JSON.stringify(wireFields)}`;
if (loggedDefenderShapes.has(key)) return;
loggedDefenderShapes.add(key);
const fields = (wireFields as { defender_config: DefenderApiConfig }).defender_config;
console.warn(
colorizeOverrideWarning(
`Defender configured via SDK (enabled=${fields.enabled}, blockHighRisk=${fields.block_high_risk}, useTier1Classification=${fields.use_tier1_classification}, useTier2Classification=${fields.use_tier2_classification}); project dashboard setting will be ignored.`,
),
);
}
/**
* Map SDK DefenderConfig to the wire-format sent in the RPC body.
*
* - `null` → explicitly disabled (all fields false, overrides project setting)
* - `{ useProjectSettings: true }` → empty object (omitted from payload, project setting controls)
* - explicit object → wire format with missing fields filled from `DEFAULT_DEFENDER_CONFIG`
*/
function buildDefenderFields(
config: DefenderConfig | null,
): { defender_config: DefenderApiConfig } | Record<string, never> {
if (config === null) {
return {
defender_config: {
enabled: false,
block_high_risk: false,
use_tier1_classification: false,
use_tier2_classification: false,
},
};
}
if (usesProjectSettings(config)) {
return {};
}
return {
defender_config: {
enabled: config.enabled ?? DEFAULT_DEFENDER_CONFIG.enabled,
block_high_risk: config.blockHighRisk ?? DEFAULT_DEFENDER_CONFIG.blockHighRisk,
use_tier1_classification:
config.useTier1Classification ?? DEFAULT_DEFENDER_CONFIG.useTier1Classification,
use_tier2_classification:
config.useTier2Classification ?? DEFAULT_DEFENDER_CONFIG.useTier2Classification,
},
};
}
/**
* Class for loading StackOne tools via MCP
*/
export class StackOneToolSet {
private baseUrl?: string;
private authentication?: AuthenticationConfig;
private headers: Record<string, string>;
private rpcClient?: RpcClient;
private readonly timeout: number;
private readonly searchConfig: SearchConfig | null;
private readonly executeConfig: ExecuteToolsConfig | undefined;
private readonly defenderConfig: DefenderConfig | null;
private readonly defenderFields: { defender_config: DefenderApiConfig } | Record<string, never>;
/**
* Account ID for StackOne API
*/
private accountId?: string;
private accountIds: string[] = [];
/**
* Initialize StackOne toolset with API key and optional account ID(s)
* @param config Configuration object containing API key and optional account ID(s)
*/
constructor(config?: StackOneToolSetConfig) {
// Validate mutually exclusive account options
if (config?.accountId != null && config?.accountIds != null) {
throw new ToolSetConfigError(
'Cannot provide both accountId and accountIds. Use accountId for a single account or accountIds for multiple accounts.',
);
}
const apiKey = config?.apiKey || process.env.STACKONE_API_KEY;
if (!apiKey && config?.strict) {
throw new ToolSetConfigError(
'No API key provided. Set STACKONE_API_KEY environment variable or pass apiKey in config.',
);
}
Iif (!apiKey) {
console.warn(
'No API key provided. Set STACKONE_API_KEY environment variable or pass apiKey in config.',
);
}
const authentication: AuthenticationConfig = {
type: 'basic',
credentials: {
username: apiKey || '',
password: '',
},
};
const accountId = config?.accountId || process.env.STACKONE_ACCOUNT_ID;
const configHeaders = {
...config?.headers,
...(accountId ? { 'x-account-id': accountId } : {}),
};
// Initialize base properties
this.baseUrl = config?.baseUrl ?? process.env.STACKONE_BASE_URL ?? DEFAULT_BASE_URL;
this.authentication = authentication;
this.headers = configHeaders;
this.rpcClient = config?.rpcClient;
this.timeout = config?.timeout ?? config?.execute?.timeout ?? 60_000;
this.accountId = accountId;
this.accountIds = config?.accountIds ?? [];
// Resolve search config: undefined/null → disabled, object → custom with defaults
this.searchConfig = config?.search != null ? { method: 'auto', ...config.search } : null;
this.executeConfig = config?.execute;
// Resolve defender config:
// undefined → defer to project dashboard setting (normalized to { useProjectSettings: true })
// null → explicitly disabled (overrides project setting)
// object → validate then store as-is
const defenderInput = config?.defender;
if (
defenderInput != null &&
typeof defenderInput === 'object' &&
usesProjectSettings(defenderInput) &&
Object.keys(defenderInput).length > 1
) {
throw new ToolSetConfigError(
'Cannot combine useProjectSettings: true with explicit defender options. Use one or the other.',
);
}
this.defenderConfig =
defenderInput === undefined ? { useProjectSettings: true } : defenderInput;
this.defenderFields = buildDefenderFields(this.defenderConfig);
logDefenderOverride(this.defenderConfig, this.defenderFields);
// Set Authentication headers if provided
if (this.authentication) {
// Only set auth headers if they don't already exist in custom headers
const needsAuthHeader = !('Authorization' in this.headers);
if (needsAuthHeader) {
switch (this.authentication.type) {
case 'basic':
Eif (this.authentication.credentials?.username) {
const username = this.authentication.credentials.username;
const password = this.authentication.credentials.password || '';
const authString = Buffer.from(`${username}:${password}`).toString('base64');
this.headers.Authorization = `Basic ${authString}`;
}
break;
case 'bearer':
if (this.authentication.credentials?.token) {
this.headers.Authorization = `Bearer ${this.authentication.credentials.token}`;
}
break;
default:
this.authentication.type satisfies never;
throw new ToolSetError(
`Unsupported authentication type: ${String(this.authentication.type)}`,
);
}
}
// Add any additional headers from authentication config, but don't override existing ones
Iif (this.authentication.headers) {
this.headers = { ...this.authentication.headers, ...this.headers };
}
}
}
private semanticSearchClient?: SemanticSearchClient;
private catalogCache: Map<string, Tools> = new Map();
private toolIndexCache?: { tools: Tools; index: ToolIndex };
/**
* Resolved defender behavior for this toolset.
*
* - `'project'` — SDK adds no `defender_config` to the RPC payload; the project dashboard controls.
* - `'disabled'` — SDK forces defender off (overrides the dashboard).
* - `'explicit'` — SDK sends an explicit `defender_config` (overrides the dashboard).
*/
get defenderMode(): DefenderMode {
if (this.defenderConfig === null) return 'disabled';
if (usesProjectSettings(this.defenderConfig)) return 'project';
return 'explicit';
}
/**
* Set account IDs for filtering tools
* @param accountIds Array of account IDs to filter tools by
* @returns This toolset instance for chaining
*/
setAccounts(accountIds: string[]): this {
this.accountIds = accountIds;
this.clearCatalogCache();
return this;
}
/**
* Invalidate cached tool catalog and local search index.
*
* Call when linked accounts change outside of {@link setAccounts} or when
* you need to force a fresh fetch from the StackOne MCP endpoint.
*/
clearCatalogCache(): void {
this.catalogCache.clear();
this.toolIndexCache = undefined;
}
/**
* Get or lazily create the semantic search client.
*/
private getSemanticClient(): SemanticSearchClient {
Eif (!this.semanticSearchClient) {
const apiKey = this.getApiKey();
this.semanticSearchClient = new SemanticSearchClient({
apiKey,
baseUrl: this.baseUrl,
});
}
return this.semanticSearchClient;
}
/**
* Get the current search config.
*/
getSearchConfig(): SearchConfig | null {
return this.searchConfig;
}
/**
* Extract the API key from authentication config.
*/
private getApiKey(): string {
const credentials = this.authentication?.credentials ?? {};
const apiKeyFromAuth =
this.authentication?.type === 'basic'
? credentials.username
: this.authentication?.type === 'bearer'
? credentials.token
: credentials.username;
const apiKey = apiKeyFromAuth || process.env.STACKONE_API_KEY;
Iif (!apiKey) {
throw new ToolSetConfigError(
'API key is required for semantic search. Provide apiKey in config or set STACKONE_API_KEY environment variable.',
);
}
return apiKey;
}
/**
* Get a callable search tool that returns Tools collections.
*
* Returns a SearchTool instance that wraps `searchTools()` for use in agent loops.
*
* @param options - Options including the default search mode
* @returns SearchTool instance
*
* @example
* ```typescript
* const toolset = new StackOneToolSet({ apiKey: 'sk-xxx' });
* const searchTool = toolset.getSearchTool();
* const tools = await searchTool.search('manage employee records', { accountIds: ['acc-123'] });
* ```
*/
getSearchTool(options?: { search?: SearchMode }): SearchTool {
Iif (this.searchConfig === null) {
throw new ToolSetConfigError(
'Search is disabled. Initialize StackOneToolSet with a search config to enable.',
);
}
const config: SearchConfig = options?.search
? { ...this.searchConfig, method: options.search }
: this.searchConfig;
return new SearchTool(this, config);
}
/**
* Get tool_search + tool_execute for agent-driven discovery.
*
* Returns a Tools collection with two tools that let the LLM
* discover and execute tools on-demand.
*
* @param options - Options to scope tool discovery
* @returns Tools collection containing tool_search and tool_execute
*/
getTools(options?: { accountIds?: string[] }): Tools {
const accountIds =
options?.accountIds ??
this.executeConfig?.accountIds ??
(this.accountIds.length > 0 ? this.accountIds : undefined);
return this.buildTools(accountIds);
}
/**
* Build tool_search + tool_execute tools scoped to this toolset.
*/
private buildTools(accountIds?: string[], connectors?: string): Tools {
if (this.searchConfig === null) {
throw new ToolSetConfigError(
'Search is disabled. Initialize StackOneToolSet with a search config to enable.',
);
}
const searchTool = createSearchTool(this, accountIds, connectors);
const executeTool = createExecuteTool(this, accountIds, connectors);
return new Tools([searchTool, executeTool]);
}
/**
* Get tools in OpenAI function calling format.
*
* @param options - Options
* @param options.mode - Tool mode.
* `undefined` (default): fetch all tools and convert to OpenAI format.
* `"search_and_execute"`: return two tools (tool_search + tool_execute)
* that let the LLM discover and execute tools on-demand.
* @param options.accountIds - Account IDs to scope tools. Overrides the `execute`
* config from the constructor.
* @returns List of tool definitions in OpenAI function format.
*
* @example
* ```typescript
* // All tools
* const toolset = new StackOneToolSet();
* const tools = await toolset.openai();
*
* // Search and execute for agent-driven discovery
* const toolset = new StackOneToolSet({ search: {} });
* const tools = await toolset.openai({ mode: 'search_and_execute' });
* ```
*/
async openai(options?: {
mode?: 'search_and_execute';
accountIds?: string[];
}): Promise<ReturnType<Tools['toOpenAI']>> {
const effectiveAccountIds = options?.accountIds ?? this.executeConfig?.accountIds;
if (options?.mode === 'search_and_execute') {
// Discover available connectors for dynamic descriptions
let connectors: string | undefined;
try {
const allTools = await this.fetchTools({ accountIds: effectiveAccountIds });
const connectorSet = allTools.getConnectors();
if (connectorSet.size > 0) {
connectors = Array.from(connectorSet).sort().join(', ');
}
} catch {
// Best-effort: if discovery fails, use generic descriptions
}
return this.buildTools(effectiveAccountIds, connectors).toOpenAI();
}
const tools = await this.fetchTools({ accountIds: effectiveAccountIds });
return tools.toOpenAI();
}
/**
* Search for and fetch tools using semantic or local search.
*
* This method discovers relevant tools based on natural language queries.
*
* @param query - Natural language description of needed functionality
* (e.g., "create employee", "send a message")
* @param options - Search options
* @returns Tools collection with matched tools from linked accounts
* @throws SemanticSearchError if the API call fails and search is "semantic"
*
* @example
* ```typescript
* // Semantic search (default with local fallback)
* const tools = await toolset.searchTools('manage employee records', { topK: 5 });
*
* // Explicit semantic search
* const tools = await toolset.searchTools('manage employees', { search: 'semantic' });
*
* // Local BM25+TF-IDF search
* const tools = await toolset.searchTools('manage employees', { search: 'local' });
*
* // Filter by connector
* const tools = await toolset.searchTools('create time off request', {
* connector: 'bamboohr',
* search: 'semantic',
* });
* ```
*/
async searchTools(query: string, options?: SearchToolsOptions): Promise<Tools> {
Iif (this.searchConfig === null) {
throw new ToolSetConfigError(
'Search is disabled. Initialize StackOneToolSet with a search config to enable.',
);
}
const search = options?.search ?? this.searchConfig.method ?? 'auto';
const topK = options?.topK ?? this.searchConfig.topK;
const minSimilarity = options?.minSimilarity ?? this.searchConfig.minSimilarity;
const mergedOptions = { ...options, search, topK, minSimilarity };
const allTools = await this.fetchTools({ accountIds: mergedOptions.accountIds });
const availableConnectors = allTools.getConnectors();
Iif (availableConnectors.size === 0) {
return new Tools([]);
}
// Local-only search — skip semantic API entirely
if (search === 'local') {
return this.localSearch(query, allTools, mergedOptions);
}
try {
// Determine which connectors to search
let connectorsToSearch: Set<string>;
Iif (mergedOptions.connector) {
const connectorLower = mergedOptions.connector.toLowerCase();
connectorsToSearch = availableConnectors.has(connectorLower)
? new Set([connectorLower])
: new Set();
if (connectorsToSearch.size === 0) {
return new Tools([]);
}
} else {
connectorsToSearch = availableConnectors;
}
// Search each connector in parallel — in auto mode, treat missing
// API key as "semantic unavailable" and fall back to local search.
let client: SemanticSearchClient;
try {
client = this.getSemanticClient();
} catch (error) {
if (search === 'auto' && error instanceof ToolSetConfigError) {
return this.localSearch(query, allTools, mergedOptions);
}
throw error;
}
const allResults: SemanticSearchResult[] = [];
let lastError: SemanticSearchError | undefined;
const searchPromises = [...connectorsToSearch].map(async (connector) => {
try {
const response = await client.search(query, {
connector,
topK: mergedOptions.topK,
minSimilarity: mergedOptions.minSimilarity,
});
return response.results;
} catch (error) {
Eif (error instanceof SemanticSearchError) {
lastError = error;
return [];
}
throw error;
}
});
const resultArrays = await Promise.all(searchPromises);
for (const results of resultArrays) {
allResults.push(...results);
}
// If ALL connector searches failed, re-raise to trigger fallback
if (allResults.length === 0 && lastError) {
throw lastError;
}
// Sort by score, apply topK
allResults.sort((a, b) => b.similarityScore - a.similarityScore);
const topResults =
mergedOptions.topK != null ? allResults.slice(0, mergedOptions.topK) : allResults;
if (topResults.length === 0) {
return new Tools([]);
}
// 1. Parse composite IDs to MCP-format action names, deduplicate
const seenNames = new Set<string>();
const actionNames: string[] = [];
for (const result of topResults) {
const name = normalizeActionName(result.id);
if (seenNames.has(name)) {
continue;
}
seenNames.add(name);
actionNames.push(name);
}
Iif (actionNames.length === 0) {
return new Tools([]);
}
// 2. Use MCP tools (already fetched) — schemas come from the source of truth
// 3. Filter to only the tools search found, preserving search relevance order
const actionOrder = new Map(actionNames.map((name, i) => [name, i]));
const matchedTools = allTools.toArray().filter((t) => seenNames.has(t.name));
matchedTools.sort(
(a, b) =>
(actionOrder.get(a.name) ?? Number.POSITIVE_INFINITY) -
(actionOrder.get(b.name) ?? Number.POSITIVE_INFINITY),
);
// Auto mode: if semantic returned results but none matched MCP tools, fall back to local
if (search === 'auto' && matchedTools.length === 0) {
return this.localSearch(query, allTools, mergedOptions);
}
return new Tools(matchedTools);
} catch (error) {
Eif (error instanceof SemanticSearchError) {
if (search === 'semantic') {
throw error;
}
// Auto mode: silently fall back to local search
return this.localSearch(query, allTools, mergedOptions);
}
throw error;
}
}
/**
* Search for action names without fetching tools.
*
* Useful when you need to inspect search results before fetching,
* or when building custom filtering logic.
*
* @param query - Natural language description of needed functionality
* @param options - Search options
* @returns List of SemanticSearchResult with action names, scores, and metadata
*
* @example
* ```typescript
* // Lightweight: inspect results before fetching
* const results = await toolset.searchActionNames('manage employees');
* for (const r of results) {
* console.log(`${r.id}: ${r.similarityScore.toFixed(2)}`);
* }
*
* // Then fetch specific high-scoring actions
* const selected = results
* .filter(r => r.similarityScore > 0.7)
* .map(r => r.id);
* const tools = await toolset.fetchTools({ actions: selected });
* ```
*/
async searchActionNames(
query: string,
options?: SearchActionNamesOptions,
): Promise<SemanticSearchResult[]> {
Iif (this.searchConfig === null) {
throw new ToolSetConfigError(
'Search is disabled. Initialize StackOneToolSet with a search config to enable.',
);
}
const effectiveTopK = options?.topK ?? this.searchConfig.topK;
const effectiveMinSimilarity = options?.minSimilarity ?? this.searchConfig.minSimilarity;
// Resolve available connectors from account IDs
let availableConnectors: Set<string> | undefined;
const effectiveAccountIds = options?.accountIds || this.accountIds;
Iif (effectiveAccountIds.length > 0) {
const allTools = await this.fetchTools({ accountIds: effectiveAccountIds });
availableConnectors = allTools.getConnectors();
if (availableConnectors.size === 0) {
return [];
}
}
try {
const client = this.getSemanticClient();
let allResults: SemanticSearchResult[] = [];
Iif (availableConnectors) {
// Parallel per-connector search (only user's connectors)
let connectorsToSearch: Set<string>;
if (options?.connector) {
const connectorLower = options.connector.toLowerCase();
connectorsToSearch = availableConnectors.has(connectorLower)
? new Set([connectorLower])
: new Set();
} else {
connectorsToSearch = availableConnectors;
}
const searchPromises = [...connectorsToSearch].map(async (connector) => {
try {
const response = await client.search(query, {
connector,
topK: effectiveTopK,
minSimilarity: effectiveMinSimilarity,
});
return response.results;
} catch {
return [];
}
});
const resultArrays = await Promise.all(searchPromises);
for (const results of resultArrays) {
allResults.push(...results);
}
} else {
// No account filtering — single global search
const response = await client.search(query, {
connector: options?.connector,
topK: effectiveTopK,
minSimilarity: effectiveMinSimilarity,
});
allResults = response.results;
}
// Sort by score — return raw results (consumers can normalize the composite ID if needed)
allResults.sort((a, b) => b.similarityScore - a.similarityScore);
return effectiveTopK != null ? allResults.slice(0, effectiveTopK) : allResults;
} catch (error) {
Eif (error instanceof SemanticSearchError) {
return [];
}
throw error;
}
}
/**
* Run local BM25+TF-IDF search over already-fetched tools.
*/
private async localSearch(
query: string,
allTools: Tools,
options?: Pick<SearchToolsOptions, 'connector' | 'topK' | 'minSimilarity'>,
): Promise<Tools> {
const availableConnectors = allTools.getConnectors();
Iif (availableConnectors.size === 0) {
return new Tools([]);
}
Eif (!this.toolIndexCache || this.toolIndexCache.tools !== allTools) {
this.toolIndexCache = { tools: allTools, index: new ToolIndex(allTools.toArray()) };
}
const index = this.toolIndexCache.index;
const results = await index.search(query, options?.topK ?? 5, options?.minSimilarity ?? 0.0);
const matchedNames = results.map((r) => r.name);
const toolMap = new Map(allTools.toArray().map((t) => [t.name, t]));
const filterConnectors = options?.connector
? new Set([options.connector.toLowerCase()])
: availableConnectors;
const matchedTools = matchedNames
.filter((name) => toolMap.has(name))
.map((name) => toolMap.get(name)!)
.filter((tool) => tool.connector && filterConnectors.has(tool.connector));
return new Tools(options?.topK != null ? matchedTools.slice(0, options.topK) : matchedTools);
}
/**
* Fetch tools from MCP with optional filtering
* @param options Optional filtering options for account IDs, providers, and actions
* @returns Collection of tools matching the filter criteria
*/
async fetchTools(options?: FetchToolsOptions): Promise<Tools> {
// Use account IDs from options, or fall back to instance state
const effectiveAccountIds = options?.accountIds || this.accountIds;
const cacheKey = JSON.stringify({
accountIds: [...effectiveAccountIds].sort(),
providers: options?.providers?.length ? [...options.providers].sort() : null,
actions: options?.actions?.length ? [...options.actions].sort() : null,
});
const cached = this.catalogCache.get(cacheKey);
if (cached) {
return cached;
}
// Fetch tools (with account filtering if needed)
// Headers are threaded as parameters per request — never mutate this.headers,
// since concurrent callers would clobber each other's x-account-id.
let tools: Tools;
if (effectiveAccountIds.length > 0) {
const toolsPromises = effectiveAccountIds.map(async (accountId) => {
const requestHeaders = { ...this.headers, 'x-account-id': accountId };
const accountTools = await this.fetchToolsFromMcp(requestHeaders);
return accountTools.toArray();
});
const toolArrays = await Promise.all(toolsPromises);
const allTools = toolArrays.flat();
tools = new Tools(allTools);
} else {
// No account filtering - fetch all tools
tools = await this.fetchToolsFromMcp(this.headers);
}
// Apply provider and action filters
const filteredTools = this.filterTools(tools, options);
// Add feedback tool
const feedbackTool = createFeedbackTool(undefined, this.accountId, this.baseUrl);
const toolsWithFeedback = new Tools([...filteredTools.toArray(), feedbackTool]);
this.catalogCache.set(cacheKey, toolsWithFeedback);
return toolsWithFeedback;
}
/**
* Fetch tool definitions from MCP using the given request headers.
* Headers are passed in (not read from this.headers) so concurrent callers
* can each scope their request to a different x-account-id safely.
*/
private async fetchToolsFromMcp(requestHeaders: Record<string, string>): Promise<Tools> {
Iif (!this.baseUrl) {
throw new ToolSetConfigError('baseUrl is required to fetch MCP tools');
}
await using clients = await createMCPClient({
baseUrl: `${this.baseUrl}/mcp`,
headers: requestHeaders,
});
await clients.client.connect(clients.transport);
const listToolsResult = await clients.client.listTools();
const actionsClient = this.getActionsClient();
const tools = listToolsResult.tools.map(({ name, description, inputSchema }) => {
return this.createRpcBackedTool({
actionsClient,
name,
description,
inputSchema,
headers: requestHeaders,
});
});
return new Tools(tools);
}
/**
* Filter tools by providers and actions
* @param tools Tools collection to filter
* @param options Filtering options
* @returns Filtered tools collection
*/
private filterTools(tools: Tools, options?: FetchToolsOptions): Tools {
let filteredTools = tools.toArray();
// Filter by providers if specified
if (options?.providers && options.providers.length > 0) {
const providerSet = new Set(options.providers.map((p) => p.toLowerCase()));
filteredTools = filteredTools.filter((tool) => {
return tool.connector && providerSet.has(tool.connector);
});
}
// Filter by actions if specified (with glob support)
if (options?.actions && options.actions.length > 0) {
filteredTools = filteredTools.filter((tool) =>
options.actions?.some((pattern) => this.matchGlob(tool.name, pattern)),
);
}
return new Tools(filteredTools);
}
/**
* Check if a string matches a glob pattern
* @param str String to check
* @param pattern Glob pattern
* @returns True if the string matches the pattern
*/
private matchGlob(str: string, pattern: string): boolean {
// Convert glob pattern to regex
const regexPattern = pattern.replace(/\./g, '\\.').replace(/\*/g, '.*').replace(/\?/g, '.');
// Create regex with start and end anchors
const regex = new RegExp(`^${regexPattern}$`);
// Test if the string matches the pattern
return regex.test(str);
}
private getActionsClient(): RpcClient {
if (this.rpcClient) {
return this.rpcClient;
}
const credentials = this.authentication?.credentials ?? {};
const apiKeyFromAuth =
this.authentication?.type === 'basic'
? credentials.username
: this.authentication?.type === 'bearer'
? credentials.token
: credentials.username;
const apiKey = apiKeyFromAuth || process.env.STACKONE_API_KEY;
const password = this.authentication?.type === 'basic' ? (credentials.password ?? '') : '';
Iif (!apiKey) {
throw new ToolSetConfigError(
'StackOne API key is required to create an actions client. Provide rpcClient, configure authentication credentials, or set the STACKONE_API_KEY environment variable.',
);
}
this.rpcClient = new RpcClient({
serverURL: this.baseUrl,
security: {
username: apiKey,
password,
},
timeout: this.timeout,
});
return this.rpcClient;
}
private createRpcBackedTool({
actionsClient,
name,
description,
inputSchema,
headers,
}: {
actionsClient: RpcClient;
name: string;
description?: string;
inputSchema: ToolInputSchema;
headers: Record<string, string>;
}): BaseTool {
const executeConfig = {
kind: 'rpc',
method: 'POST',
url: `${this.baseUrl}/actions/rpc`,
payloadKeys: {
action: 'action',
body: 'body',
headers: 'headers',
path: 'path',
query: 'query',
},
} as const satisfies RpcExecuteConfig; // Mirrors StackOne RPC payload layout so metadata/debug stays in sync.
const toolParameters = {
...inputSchema,
// properties are not well typed in MCP spec
properties: inputSchema?.properties as JsonSchemaProperties,
} satisfies ToolParameters;
const tool = new BaseTool(
name,
description ?? '',
toolParameters,
executeConfig,
headers,
).setExposeExecutionMetadata(false);
tool.execute = async (
inputParams?: JsonObject | string,
options?: ExecuteOptions,
): Promise<JsonObject> => {
try {
if (
inputParams !== undefined &&
typeof inputParams !== 'object' &&
typeof inputParams !== 'string'
) {
throw new StackOneError(
`Invalid parameters type. Expected object or string, got ${typeof inputParams}. Parameters: ${JSON.stringify(inputParams)}`,
);
}
const parsedParams =
typeof inputParams === 'string' ? JSON.parse(inputParams) : (inputParams ?? {});
const currentHeaders = tool.getHeaders();
const baseHeaders = this.buildActionHeaders(currentHeaders);
const pathParams = this.extractRecord(parsedParams, 'path');
const queryParams = this.extractRecord(parsedParams, 'query');
const additionalHeaders = this.extractRecord(parsedParams, 'headers');
const extraHeaders = normalizeHeaders(additionalHeaders);
// defu merges extraHeaders into baseHeaders, both are already branded types
const actionHeaders = defu(extraHeaders, baseHeaders);
const bodyPayload = this.extractRecord(parsedParams, 'body');
const rpcBody: JsonObject = bodyPayload ? { ...bodyPayload } : {};
for (const [key, value] of Object.entries(parsedParams)) {
if (key === 'body' || key === 'headers' || key === 'path' || key === 'query') {
continue;
}
rpcBody[key] = value as JsonObject[string];
}
if (options?.dryRun) {
const requestPayload = {
action: name,
body: rpcBody,
...this.defenderFields,
headers: actionHeaders,
path: pathParams ?? undefined,
query: queryParams ?? undefined,
};
return {
url: executeConfig.url,
method: executeConfig.method,
headers: actionHeaders,
body: JSON.stringify(requestPayload),
mappedParams: parsedParams,
} satisfies JsonObject;
}
const response = await actionsClient.actions.rpcAction({
action: name,
body: rpcBody,
...this.defenderFields,
headers: actionHeaders,
path: pathParams ?? undefined,
query: queryParams ?? undefined,
});
return rpcResponseToJsonObject(response);
} catch (error) {
if (error instanceof StackOneError) {
throw error;
}
throw new StackOneError(`Error executing RPC action ${name}`, { cause: error });
}
};
return tool;
}
private buildActionHeaders(headers: Record<string, string>): StackOneHeaders {
const sanitizedEntries = Object.entries(headers).filter(
([key]) => key.toLowerCase() !== 'authorization',
);
return stackOneHeadersSchema.parse(
Object.fromEntries(sanitizedEntries.map(([key, value]) => [key, String(value)])),
);
}
private extractRecord(
params: JsonObject,
key: 'body' | 'headers' | 'path' | 'query',
): JsonObject | undefined {
const value = params[key];
if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
return value as JsonObject;
}
return undefined;
}
}
|