Class CapabilityRegistry

constructor

• new CapabilityRegistry(): CapabilityRegistry

  Constructs a registry pre-seeded from the generated capability list.

  Returns CapabilityRegistry

  Example

  const registry = new CapabilityRegistry();
  logger.info(registry.list().length);
  Copy

Static ReadonlyregistryVersion

byCategory

• byCategory(category: string): CapabilityEntry[]

  Returns capabilities matching the given category.

  Parameters

  • category: string

    Category string to filter by (case-sensitive).

  Returns CapabilityEntry[]

  Entries whose category matches exactly.

  Example

  const navCaps = registry.byCategory('navigation');
  Copy

find

• find(query: string): CapabilityEntry[]

  Searches capabilities by partial match against name or description.

  Parameters

  • query: string

    Substring to search for.

  Returns CapabilityEntry[]

  Entries whose name or description contains the query.

  Remarks

  Case-insensitive substring match. For semantic search, feed the result list into an embedding model or pass forAI() output to an LLM.

  Example

  const clickCaps = registry.find('click');
  Copy

findByName

• findByName(name: string): CapabilityEntry | undefined

  Returns the first capability entry matching the given name, or undefined.

  Parameters

  • name: string

    Human-readable capability name to look up (case-sensitive).

  Returns CapabilityEntry | undefined

  The matching entry, or undefined if not found.

  Remarks

  Searches by human-readable name (not id). For exact ID lookup use get().

  Example

  const cap = registry.findByName('clickButton');
  if (cap !== undefined) {
    logger.info(cap.usage_example);
  }
  Copy

forAI

• forAI(): CapabilitiesJSON

  Returns the full registry as structured JSON optimised for AI agent consumption.

  Returns CapabilitiesJSON

  Structured JSON snapshot of the entire registry.

  Remarks

  Currently an alias for toJSON(). Future releases may apply provider-specific formatting or token-budget-aware truncation.

  Example

  const aiContext = registry.forAI();
  const prompt = JSON.stringify(aiContext);
  Copy

forProvider

• forProvider(provider: AiProviderName): string

  Returns capabilities formatted for a specific AI provider.

  Parameters

  • provider: AiProviderName

    Target AI provider name.

  Returns string

  Formatted capability descriptions as a string.

  Remarks

  Each provider receives a format optimised for its native consumption pattern:

  • 'claude' — XML-structured {@literal <capability>} elements with attributes
  • 'openai' — JSON array of function-calling tool schemas
  • 'gemini' — Plain text listing with name, description, and example

  Example

  const registry = new CapabilityRegistry();
  const claudeContext = registry.forProvider('claude');
  const openaiTools = registry.forProvider('openai');
  const geminiText = registry.forProvider('gemini');
  Copy

get

• get(id: string): CapabilityEntry | undefined

  Returns the capability entry with the given id, or undefined.

  Parameters

  • id: string

    Unique kebab-case capability identifier.

  Returns CapabilityEntry | undefined

  The matching entry, or undefined if not registered.

  Example

  const cap = registry.get('click-button');
  if (cap !== undefined) {
    logger.info(cap.usage_example);
  }
  Copy

getStatistics

• getStatistics(): CapabilityStats

  Returns a statistical summary of the capability registry.

  Returns CapabilityStats

  Statistics including total count, categories, and priority breakdown.

  Example

  const stats = registry.getStatistics();
  logger.info(`Total: ${stats.totalMethods}`);
  Copy

has

• has(name: string): boolean

  Returns true if a capability with the given name is registered.

  Parameters

  • name: string

    Human-readable capability name to look up.

  Returns boolean

  true when at least one entry matches.

  Remarks

  Searches by name (not id). Names are not guaranteed unique but are human-readable and match the TSDoc @capability tag value.

  Example

  if (registry.has('clickButton')) {
    // safe to use
  }
  Copy

list

• list(): CapabilityEntry[]

  Returns all registered capability entries.

  Returns CapabilityEntry[]

  Shallow copy of the full capability list.

  Example

  const all = registry.list();
  logger.info(all.length);
  Copy

listByPriority

• listByPriority(
      priority: "fixture" | "namespace" | "implementation",
  ): CapabilityEntry[]

  Returns capabilities matching the given priority tier.

  Parameters

  • priority: "fixture" | "namespace" | "implementation"

    Priority level to filter by.

  Returns CapabilityEntry[]

  Entries whose priority matches exactly.

  Example

  const fixtures = registry.listByPriority('fixture');
  const handlers = registry.listByPriority('namespace');
  Copy

register

• register(entry: CapabilityEntry): void

  Registers a new capability entry or overwrites an existing one by id.

  Parameters

  • entry: CapabilityEntry

    Capability entry to add or replace.

  Returns void

  Remarks

  Intended for use in tests and plugins. The generated file should not call this method — run npm run generate:capabilities instead.

  Example

  registry.register({
    id: 'my-capability',
    name: 'myCapability',
    description: 'Does something useful',
    category: 'custom',
    usage_example: 'await custom.doSomething()',
    registryVersion: 1,
  });
  Copy

toJSON

• toJSON(): CapabilitiesJSON

  Exports the full registry as a structured JSON object.

  Returns CapabilitiesJSON

  Structured JSON snapshot of the entire registry.

  Remarks

  Fixtures are listed first (Playwright best practice), then all methods.

  Example

  const json = registry.toJSON();
  logger.info(JSON.stringify(json, null, 2));
  Copy