Runbook: Toolkits

Auto-generated from ./src/toolkits/index.ts. Do not edit by hand — run node scripts/gen-runbooks.mjs.

Import path: personaforge/toolkits · Public symbols: 9 · Guide: /guide/toolkits

What it is

personaforge/toolkits is a public entry point of personaforge. Import it directly; you only pull in this feature's code (subpath exports are tree-shakeable and optional native deps load lazily).

Install

npm i personaforge
# or: bun add personaforge · pnpm add personaforge · yarn add personaforge

Import

import { sqlToolkit, httpToolkit, fileToolkit } from 'personaforge/toolkits';

Public API surface

• Factories / functions — sqlToolkit, httpToolkit, fileToolkit, combineToolkits
• Interfaces — Tool, PromptedToolkit, SqlToolkitConfig, HttpToolkitConfig, FileToolkitConfig

Minimal use

Real example from the toolkits guide:

const kit = sqlToolkit({
  execute: async (q) => db.query(q),
  listTables: async () => ['users', 'orders'],
  describeTable: async (t) => db.getSchema(t),
});

const analyst = agent({
  name: 'analyst',
  instructions: [baseInstructions, kit.promptFragment].join('\n'),
  tools: kit.tools,   // sql_list_tables, sql_describe_table, sql_query
});

Verify it works

• Type-check: npx tsc --noEmit resolves personaforge/toolkits with no missing-module error.
• Runtime: node -e "import('personaforge/toolkits').then(m => console.log(Object.keys(m)))" lists the exports above.
• Behavior: follow the runnable example in /guide/toolkits.

Common failures

• Cannot find module 'personaforge/toolkits' — package not installed or stale build; run npm i personaforge and rebuild.
• Cannot find module '<peer>' at call time — this feature lazy-loads an optional native/SDK dep; install the one named in the error.
• Type errors after upgrade — check CHANGELOG.md for the symbol you import; names above are the current contract.

Rollback

• Remove the import and the feature is gone from your bundle (subpaths are isolated; nothing else depends on importing it).
• Pin a known-good version: npm i personaforge@<version>.

Related

• Full index: /runbooks/ · llms.txt
• Concept guide: /guide/toolkits