DollhouseMCP

Instructions

Implementation Reference

• src/server/tools/ConfigTools.ts:10-53 (registration)

  Registers the 'configure_indicator' MCP tool, defining its name, description, input schema, and handler that delegates to server.configureIndicator(args). Note: This file is deprecated but contains the tool definition.
  { tool: { name: "configure_indicator", description: "Configure how active persona indicators are displayed", inputSchema: { type: "object", properties: { enabled: { type: "boolean", description: "Enable or disable persona indicators", }, style: { type: "string", description: "Display style: full, minimal, compact, or custom", }, customFormat: { type: "string", description: "Custom format string (for style=custom). Use placeholders: {name}, {version}, {author}, {category}", }, includeEmoji: { type: "boolean", description: "Include emoji in indicator (🎭)", }, includeBrackets: { type: "boolean", description: "Wrap indicator in brackets", }, includeVersion: { type: "boolean", description: "Include version in indicator", }, includeAuthor: { type: "boolean", description: "Include author in indicator", }, includeCategory: { type: "boolean", description: "Include category in indicator", }, }, }, }, handler: (args: any) => server.configureIndicator(args) },
• src/types/mcp.ts:90-102 (schema)

  Zod schema defining the input arguments for the configure_indicator tool.
  export const ConfigureIndicatorArgsSchema = z.object({ enabled: z.boolean().optional().describe("Whether to show indicators"), style: z.enum(['full', 'minimal', 'compact', 'custom']).optional().describe("Display style"), customFormat: z.string().optional().describe("Custom format string"), showEmoji: z.boolean().optional().describe("Show emoji in indicator"), showName: z.boolean().optional().describe("Show persona name"), showVersion: z.boolean().optional().describe("Show version"), showAuthor: z.boolean().optional().describe("Show author"), showCategory: z.boolean().optional().describe("Show category"), separator: z.string().optional().describe("Separator after indicator"), emoji: z.string().optional().describe("Custom emoji to use"), bracketStyle: z.enum(['square', 'round', 'curly', 'angle', 'none']).optional().describe("Bracket style") });
• src/config/indicator-config.ts:1-238 (helper)

  Helper module for persona indicator configuration: defines IndicatorConfig interface, defaults, loadIndicatorConfig() from env vars, and formatIndicator() to generate the display string based on config and persona metadata.
  /** * Configuration interface for the persona active indicator system. * Controls how persona information is displayed in AI responses. * * @interface IndicatorConfig * @example * ```typescript * const config: IndicatorConfig = { * enabled: true, * style: 'full', * showEmoji: true, * showName: true, * showVersion: true, * showAuthor: true, * showCategory: false, * separator: ' | ', * emoji: '🎭', * bracketStyle: 'square' * }; * ``` */ export interface IndicatorConfig { /** Whether to show the indicator at all */ enabled: boolean; /** Format style: 'full', 'minimal', 'compact', 'custom' */ style: 'full' | 'minimal' | 'compact' | 'custom'; /** * Custom format template (used when style is 'custom') * Available placeholders: {emoji}, {name}, {version}, {author}, {category} */ customFormat?: string; /** Whether to include specific elements */ showEmoji: boolean; showName: boolean; showVersion: boolean; showAuthor: boolean; showCategory: boolean; /** Separator between indicator and response */ separator: string; /** Emoji to use (defaults to 🎭) */ emoji: string; /** Bracket style: 'square', 'round', 'curly', 'angle', 'none' */ bracketStyle: 'square' | 'round' | 'curly' | 'angle' | 'none'; } // Default configuration export const DEFAULT_INDICATOR_CONFIG: IndicatorConfig = { enabled: true, style: 'full', showEmoji: true, showName: true, showVersion: true, showAuthor: true, showCategory: false, separator: ' | ', emoji: '🎭', bracketStyle: 'square' }; // Predefined styles export const INDICATOR_STYLES = { full: '[{emoji} {name} v{version} by {author}]', minimal: '{emoji} {name}', compact: '[{name} v{version}]', custom: '{customFormat}' }; // Bracket mappings export const BRACKETS = { square: { open: '[', close: ']' }, round: { open: '(', close: ')' }, curly: { open: '{', close: '}' }, angle: { open: '<', close: '>' }, none: { open: '', close: '' } }; /** * Load indicator configuration from environment variables or use defaults. * Environment variables take precedence over default values. * * @returns {IndicatorConfig} The loaded configuration * @example * ```typescript * // Set environment variables before loading * process.env.DOLLHOUSE_INDICATOR_STYLE = 'minimal'; * process.env.DOLLHOUSE_INDICATOR_EMOJI = '🤖'; * * const config = loadIndicatorConfig(); * // config.style === 'minimal' * // config.emoji === '🤖' * ``` */ export function loadIndicatorConfig(): IndicatorConfig { const config = { ...DEFAULT_INDICATOR_CONFIG }; // Check environment variables for overrides if (process.env.DOLLHOUSE_INDICATOR_ENABLED !== undefined) { config.enabled = process.env.DOLLHOUSE_INDICATOR_ENABLED === 'true'; } if (process.env.DOLLHOUSE_INDICATOR_STYLE) { const style = process.env.DOLLHOUSE_INDICATOR_STYLE; if (['full', 'minimal', 'compact', 'custom'].includes(style)) { config.style = style as IndicatorConfig['style']; } } if (process.env.DOLLHOUSE_INDICATOR_FORMAT) { config.customFormat = process.env.DOLLHOUSE_INDICATOR_FORMAT; config.style = 'custom'; } if (process.env.DOLLHOUSE_INDICATOR_EMOJI) { config.emoji = process.env.DOLLHOUSE_INDICATOR_EMOJI; } if (process.env.DOLLHOUSE_INDICATOR_BRACKETS) { const bracketStyle = process.env.DOLLHOUSE_INDICATOR_BRACKETS; if (['square', 'round', 'curly', 'angle', 'none'].includes(bracketStyle)) { config.bracketStyle = bracketStyle as IndicatorConfig['bracketStyle']; } } // Parse show flags from environment if (process.env.DOLLHOUSE_INDICATOR_SHOW_VERSION !== undefined) { config.showVersion = process.env.DOLLHOUSE_INDICATOR_SHOW_VERSION === 'true'; } if (process.env.DOLLHOUSE_INDICATOR_SHOW_AUTHOR !== undefined) { config.showAuthor = process.env.DOLLHOUSE_INDICATOR_SHOW_AUTHOR === 'true'; } if (process.env.DOLLHOUSE_INDICATOR_SHOW_CATEGORY !== undefined) { config.showCategory = process.env.DOLLHOUSE_INDICATOR_SHOW_CATEGORY === 'true'; } return config; } /** * Validate custom format template for valid placeholders */ export function validateCustomFormat(format: string): { valid: boolean; error?: string } { const validPlaceholders = ['{emoji}', '{name}', '{version}', '{author}', '{category}']; // Length limit added to prevent ReDoS attacks const placeholderRegex = /\{[^}]{0,50}\}/g; // Limited to 50 chars for placeholder names const foundPlaceholders = format.match(placeholderRegex) || []; for (const placeholder of foundPlaceholders) { if (!validPlaceholders.includes(placeholder)) { return { valid: false, error: `Invalid placeholder: ${placeholder}. Valid placeholders are: ${validPlaceholders.join(', ')}` }; } } return { valid: true }; } /** * Format the indicator based on configuration and persona metadata */ export function formatIndicator( config: IndicatorConfig, metadata: { name: string; version?: string; author?: string; category?: string; } ): string { if (!config.enabled) { return ''; } // Get the format template based on style let template = INDICATOR_STYLES[config.style]; if (config.style === 'custom' && config.customFormat) { // Validate custom format const validation = validateCustomFormat(config.customFormat); if (!validation.valid) { // Fall back to full style if custom format is invalid template = INDICATOR_STYLES.full; } else { template = config.customFormat; } } // Replace placeholders with values or empty strings let result = template .replace('{emoji}', config.showEmoji ? config.emoji : '') .replace('{name}', config.showName ? metadata.name : '') .replace('{version}', config.showVersion && metadata.version ? metadata.version : '') .replace('{author}', config.showAuthor && metadata.author ? metadata.author : '') .replace('{category}', config.showCategory && metadata.category ? metadata.category : ''); // Clean up the format string // Remove "v" if no version follows it if (!config.showVersion || !metadata.version) { result = result.replace(/\sv(?=\s|]|\)|>|}|$)/, ''); } // Remove "by" if no author follows it if (!config.showAuthor || !metadata.author) { result = result.replace(/\sby(?=\s|]|\)|>|}|$)/, ''); } // Clean up extra spaces result = result.replaceAll(/\s+/g, ' ').trim(); // Apply brackets based on the template format (only if template doesn't already have them) if (result && config.style !== 'custom') { // Check if the template already includes brackets const templateHasBrackets = template.includes('[') || template.includes(']') || template.includes('(') || template.includes(')') || template.includes('{') || template.includes('}') || template.includes('<') || template.includes('>'); if (!templateHasBrackets) { const brackets = BRACKETS[config.bracketStyle]; if (brackets.open || brackets.close) { result = `${brackets.open}${result}${brackets.close}`; } } } // Add separator if we have content if (result) { result += config.separator; } return result; }
• src/config/ConfigManager.ts:355-359 (helper)

  ConfigManager stores persona_indicators settings in display.persona_indicators section of the YAML config file (~/.dollhouse/config.yml). The configure_indicator tool likely updates these settings via ConfigManager.updateSetting().
  persona_indicators: { enabled: true, style: 'minimal', include_emoji: true },
• src/server/types.ts:56-56 (handler)

  IToolHandler interface declares the configureIndicator method signature used by the tool handler.
  configureIndicator(config: any): Promise<any>;