Install the Bursar agent skill
The Bursar repository publishes an Agent Skill for coding agents that integrate metering, credits, plans, leases, and billing. The skill contains agent-specific procedure and safety policy; this site remains the canonical source for tutorials, concepts, and API reference.
Install the skill
Install the bursar skill at project scope with the Skills command-line interface (CLI):
npx skills add zonastery/bursar@bursar
Project scope lets your team review and version the installed skill with the application that uses it. Pass --global only when every project on the workstation should use the skill.
npx skills add zonastery/bursar@bursar --global
Update project-scoped skills after a Bursar release:
npx skills update --project
See the Skills CLI repository for supported coding agents and installation options.
What the skill contains
The package uses progressive disclosure so a coding agent loads only the context needed for the task:
| File | Purpose |
|---|---|
SKILL.md | Trigger description, integration workflow, source lookup order, and financial safety gates |
agents/openai.yaml | User-facing metadata for clients that support skill catalogs |
assets/pricing.config.example.yaml | A complete configuration template that an agent can copy and adapt |
The skill does not copy the quickstart, API tables, billing guide, or configuration reference. It links to the maintained documentation and tells an agent to inspect the installed SDK version before writing code.
Invoke the skill
Refer to $bursar when you want an agent to apply the integration workflow explicitly. Example requests include:
Use $bursar to add replay-safe token usage charges to this API route.
Use $bursar to review this checkout webhook for double-credit risks.
Use $bursar to add a reserve and settle flow around this background job.
The skill should cause the agent to identify the installed Bursar version, inspect the relevant local types, preserve tenant isolation, and verify idempotency before changing code.
Source ownership
Each subject has one maintained owner:
| Subject | Canonical source |
|---|---|
| Integration procedure and non-negotiable agent checks | skills/bursar/SKILL.md |
| Tutorials, how-to guides, and concepts | This documentation site |
| Python and TypeScript signatures | Generated API reference and installed package types |
| PostgreSQL schema | Ordered migrations in python/src/bursar/sql/ |
| Configuration shape | Generated JSON Schema |
| Executable learning material | samples/python/notebooks/ |
This separation prevents the skill and documentation from drifting while keeping the skill useful when an agent works inside a repository checkout.
Related resources
- Read Create your first metered charge for the supported setup path
- Read Financial safety for the invariants the skill enforces
- Review the Agent Skills specification for the portable folder format
- Open the Bursar skill source to review every instruction and bundled asset