Interface ChatGuidanceContribution

Guidance a module adds to the chat's system prompt and skill set, for its own tools.

interface ChatGuidanceContribution {
    available?(): boolean | Promise<boolean>;
    hint?(): string | Promise<string>;
    skillPath?(): string | Promise<string>;
}

Index

Methods

available? hint? skillPath?

Methods

`Optional`available

available?(): boolean | Promise<boolean>
Checked when each chat session is built, like a tool's; guidance that is not available is left out. Default available.

Returns boolean | Promise<boolean>
- Defined in packages/app-core/src/services/registry.ts:22

`Optional`hint

hint?(): string | Promise<string>
Appended to the system prompt.

Returns string | Promise<string>
- Defined in packages/app-core/src/services/registry.ts:24

`Optional`skillPath

skillPath?(): string | Promise<string>
A directory holding a SKILL.md the session loads; the contributor makes sure it exists when this is called.

Returns string | Promise<string>
- Defined in packages/app-core/src/services/registry.ts:26