Skip to main content

​
Overview

import { PromptRegistry } from '@frontmcp/sdk';

// Access via scope
const prompts = scope.prompts;

// List all prompts
const allPrompts = prompts.getPrompts();

// Find a specific prompt
const prompt = prompts.findByName('code_review');

​
Methods

​
getPrompts()

Get all prompts (local + adopted). 
getPrompts(includeHidden?: boolean): ReadonlyArray<PromptEntry>
ParameterTypeDefaultDescription
includeHiddenbooleanfalseInclude hidden prompts
Example: 
// Get all visible prompts
const prompts = registry.getPrompts();

// Include hidden prompts
const allPrompts = registry.getPrompts(true);

​
findByName()

Find a prompt by its base name. 
findByName(name: string): PromptEntry | undefined
Example: 
const prompt = registry.findByName('code_review');
if (prompt) {
  console.log(`Found: ${prompt.description}`);
}

​
findAllByName()

Find all prompts matching a name (when multiple exist). 
findAllByName(name: string): ReadonlyArray<PromptEntry>
Example: 
// When multiple apps define 'greeting' prompt
const prompts = registry.findAllByName('greeting');
for (const prompt of prompts) {
  console.log(`${prompt.qualifiedId}: ${prompt.description}`);
}

​
findByQualifiedName()

Find a prompt by its fully qualified name. 
findByQualifiedName(qualifiedName: string): PromptEntry | undefined
Example: 
const prompt = registry.findByQualifiedName('my-app:code_review');

​
getExported()

Lookup a prompt by its exported (resolved) name. 
getExported(name: string, opts?: { ignoreCase?: boolean }): PromptEntry | undefined
Example: 
const prompt = registry.getExported('Code_Review');

​
exportResolvedNames()

Produce unique, conflict-aware exported names. 
exportResolvedNames(opts?: ExportResolvedNamesOptions): Map<string, PromptEntry>
Example: 
const exportedNames = registry.exportResolvedNames();
// code_review → app1:code_review
// app2_code_review → app2:code_review (conflict resolved)

​
getInlinePrompts()

Get prompts defined inline (local only). 
getInlinePrompts(): ReadonlyArray<PromptEntry>

​
listAllInstances()

List all prompt instances (locals + adopted). 
listAllInstances(): ReadonlyArray<PromptEntry>

​
listByOwner()

List prompts by owner path. 
listByOwner(ownerPath: string): ReadonlyArray<PromptEntry>
Example: 
const appPrompts = registry.listByOwner('my-app');

​
registerPromptInstance()

Register a pre-constructed PromptInstance directly. 
registerPromptInstance(prompt: PromptInstance): void
Typically used internally for remote app prompts.

​
subscribe()

Subscribe to prompt change events. 
subscribe(
  opts: SubscribeOptions,
  cb: (event: PromptChangeEvent) => void
): () => void
Returns: Unsubscribe function. Example: 
const unsubscribe = registry.subscribe({}, (event) => {
  console.log(`Prompt ${event.kind}:`, event.entry?.name);
});

// Later
unsubscribe();

​
getCapabilities()

Get MCP capabilities for prompts. 
getCapabilities(): { listChanged: boolean }
Example: 
const caps = registry.getCapabilities();
// { listChanged: true }

​
hasAny()

Check if any prompts exist. 
hasAny(): boolean

​
adoptFromChild()

Adopt prompts from a child registry. 
adoptFromChild(child: PromptRegistry, childOwner: Owner): void

​
Change Events

interface PromptChangeEvent {
  kind: 'added' | 'updated' | 'removed' | 'reset';
  changeScope: 'global' | 'session';
  version: number;
  snapshot: ReadonlyArray<PromptEntry>;
  entry?: PromptEntry;
  sessionId?: string;
  relatedRequestId?: string;
}

​
Indexes

IndexKeyDescription
byQualifiedIdqualifiedIdUnique identifier lookup
byNamenameBase name lookup
byOwnerAndNameowner:nameScoped name lookup
byOwnerownerPathAll prompts by owner

​
Prompt Arguments

Prompts can define required and optional arguments: 
@Prompt({
  name: 'code_review',
  description: 'Review code for best practices',
  arguments: [
    { name: 'language', description: 'Programming language', required: true },
    { name: 'style', description: 'Review style', required: false },
  ],
})
class CodeReviewPrompt extends PromptContext { }
Arguments are validated when the prompt is called: 
const entry = registry.findByName('code_review');
// entry.arguments contains the argument definitions