import { JSONSchema } from '../../../types/schema/JSONSchemaTypes';
import { BaseTool } from '../../baseTool';
import { ListPromptsParams, ListPromptsResult } from '../types';
import { CustomPromptStorageService } from '../services/CustomPromptStorageService';
import { getCommonResultSchema, createResult } from '../../../utils/schemaUtils';
import { addRecommendations, Recommendation } from '../../../utils/recommendationUtils';
import { NudgeHelpers } from '../../../utils/nudgeHelpers';
import { parseWorkspaceContext } from '../../../utils/contextUtils';
/**
* Tool for listing custom prompts
*/
export class ListPromptsTool extends BaseTool<ListPromptsParams, ListPromptsResult> {
private storageService: CustomPromptStorageService;
/**
* Create a new ListPromptsTool
* @param storageService Custom prompt storage service
*/
constructor(storageService: CustomPromptStorageService) {
super(
'listPrompts',
'List Prompts',
'List all custom prompts',
'1.0.0'
);
this.storageService = storageService;
}
/**
* Execute the tool
* @param params Tool parameters
* @returns Promise that resolves with the list of prompts
*/
async execute(params: ListPromptsParams): Promise<ListPromptsResult> {
try {
const { enabledOnly = false, includeArchived = false } = params;
// Get prompts based on filter
const allPrompts = this.storageService.getAllPrompts();
const enabledPrompts = this.storageService.getEnabledPrompts();
let prompts = enabledOnly ? enabledPrompts : allPrompts;
// Filter out archived (disabled) prompts unless explicitly requested
if (!includeArchived) {
prompts = prompts.filter(prompt => prompt.isEnabled !== false);
}
// Map to return only name and description for listing
const promptList = prompts.map(prompt => ({
id: prompt.id,
name: prompt.name,
description: prompt.description,
isEnabled: prompt.isEnabled
}));
// Add warning message about execute tool
const warningMessage = "IMPORTANT: Do not use the executePrompts tool or run any tasks automatically when working with these prompts. Only take on their persona and respond in character. If the user wants you to actually execute tasks or use the executePrompts functionality, they must explicitly ask you to do so.";
const result = createResult<ListPromptsResult>(true, {
prompts: promptList,
totalCount: allPrompts.length,
enabledCount: enabledPrompts.length,
message: warningMessage
}, undefined);
// Dynamic nudge based on context
const hasWorkspace = !!parseWorkspaceContext(params.workspaceContext)?.workspaceId;
const nudges: Recommendation[] = [];
const bindingNudge = NudgeHelpers.checkPromptBindingOpportunity(promptList.length, hasWorkspace);
if (bindingNudge) nudges.push(bindingNudge);
return nudges.length > 0 ? addRecommendations(result, nudges) : result;
} catch (error) {
return createResult<ListPromptsResult>(false, null, `Failed to list prompts: ${error}`);
}
}
/**
* Get the JSON schema for the tool's parameters
* @returns JSON schema object
*/
getParameterSchema(): JSONSchema {
const toolSchema = {
type: 'object',
properties: {
enabledOnly: {
type: 'boolean',
description: 'If true, only return enabled prompts',
default: false
},
includeArchived: {
type: 'boolean',
description: 'If true, include archived (disabled) prompts in results. Default false filters out archived prompts.',
default: false
}
},
required: []
};
return this.getMergedSchema(toolSchema);
}
/**
* Get the JSON schema for the tool's result
* @returns JSON schema object
*/
getResultSchema(): JSONSchema {
const commonSchema = getCommonResultSchema();
// Override the data property to define the specific structure for this tool
return {
...commonSchema,
properties: {
...commonSchema.properties,
data: {
type: 'object',
properties: {
prompts: {
type: 'array',
items: {
type: 'object',
properties: {
id: { type: 'string' },
name: { type: 'string' },
description: { type: 'string' },
isEnabled: { type: 'boolean' }
},
required: ['id', 'name', 'description', 'isEnabled']
}
},
totalCount: { type: 'number' },
enabledCount: { type: 'number' },
message: { type: 'string', description: 'Warning message about execute mode usage' }
},
required: ['prompts', 'totalCount', 'enabledCount', 'message']
}
}
};
}
}
