getcompanion-ai/co-mono
1
0
Fork 0
mirror of https://github.com/getcompanion-ai/co-mono.git synced 2026-04-21 01:01:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: clarify SDK extension discovery and settings.json support

Browse source
This commit is contained in:
Mario Zechner 2026-01-05 18:00:32 +01:00
parent 4a7e8672af
commit 3129e2ac10
2 changed files with 13 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

16
packages/coding-agent/docs/sdk.md
View file

@ -468,12 +468,15 @@ Custom tools passed via `customTools` are combined with extension-registered too
### Extensions ### Extensions
Extensions are discovered from `~/.pi/agent/extensions/` and `.pi/extensions/`. You can also pass inline extensions or additional paths: By default, extensions are discovered from multiple locations:
- `~/.pi/agent/extensions/` (global)
- `.pi/extensions/` (project-local)
- Paths listed in `settings.json` `"extensions"` array
```typescript ```typescript
import { createAgentSession, type ExtensionFactory } from "@mariozechner/pi-coding-agent"; import { createAgentSession, type ExtensionFactory } from "@mariozechner/pi-coding-agent";
// Inline extension // Inline extension factory
const myExtension: ExtensionFactory = (pi) => { const myExtension: ExtensionFactory = (pi) => {
pi.on("tool_call", async (event, ctx) => { pi.on("tool_call", async (event, ctx) => {
console.log(`Tool: ${event.toolName}`); console.log(`Tool: ${event.toolName}`);
@ -487,15 +490,20 @@ const myExtension: ExtensionFactory = (pi) => {
}); });
}; };
// Pass inline extensions (merged with discovery) // Pass inline extensions (skips file discovery)
const { session } = await createAgentSession({ const { session } = await createAgentSession({
extensions: [myExtension], extensions: [myExtension],
}); });
// Or add paths to load (merged with discovery) // Add paths to load (merged with discovery)
const { session } = await createAgentSession({ const { session } = await createAgentSession({
additionalExtensionPaths: ["/path/to/my-extension.ts"], additionalExtensionPaths: ["/path/to/my-extension.ts"],
}); });
// Disable extension discovery entirely
const { session } = await createAgentSession({
extensions: [],
});
``` ```
Extensions can register tools, subscribe to events, add commands, and more. See [extensions.md](extensions.md) for the full API. Extensions can register tools, subscribe to events, add commands, and more. See [extensions.md](extensions.md) for the full API.

2
packages/coding-agent/src/core/sdk.ts
View file

@ -101,7 +101,7 @@ export interface CreateAgentSessionOptions {
tools?: Tool[]; tools?: Tool[];
/** Custom tools to register (in addition to built-in tools). */ /** Custom tools to register (in addition to built-in tools). */
customTools?: ToolDefinition[]; customTools?: ToolDefinition[];
/** Inline extensions (merged with discovery). */ /** Inline extensions. When provided (even if empty), skips file discovery. */
extensions?: ExtensionFactory[]; extensions?: ExtensionFactory[];
/** Additional extension paths to load (merged with discovery). */ /** Additional extension paths to load (merged with discovery). */
additionalExtensionPaths?: string[]; additionalExtensionPaths?: string[];