# bun-docs-toolkit

Always-current Bun documentation for AI agents — sourced directly from `bun-types`, so it's version-pinned to whatever Bun your project uses.

## Why?

Every existing "Bun docs for AI agents" project forks or clones Bun's documentation at a point in time, then goes stale. `bun-docs-toolkit` takes a different approach: it reads documentation from the `bun-types` npm package, which ships the complete Bun docs and is already version-pinned to your installed Bun.

## What's Included

### 1. MCP Server (`bun-docs-mcp`)

A Model Context Protocol server that resolves docs from whatever `bun-types` is installed in your project.

**Setup** — add to your MCP config:

```json
{
  "mcpServers": {
    "bun-docs": {
      "command": "bunx",
      "args": ["bun-docs-mcp"]
    }
  }
}
```

**Tools:**
- `search_bun_docs({ query, category? })` — search docs by plain-English query
- `get_bun_doc({ slug })` — get the full content of a specific doc
- `list_bun_doc_categories()` — browse the category tree

### 2. Agent Skills Bundle (`skills/`)

Pre-generated `SKILL.md` files grouped by topic (~25 skills), compatible with `skills-cli`:

```bash
bunx skills add <owner>/bun-docs-toolkit
```

Skills are regenerated weekly by CI to track the latest `bun-types` release.

## Development

```bash
# Install dependencies
bun install

# Run tests
bun test

# Regenerate skills
bun run generate:skills
```

## How It Works

1. **`packages/core`** — Shared parsing: resolves `bun-types` docs dir, walks `.md`/`.mdx` files, parses YAML frontmatter, flattens Mintlify JSX components to plain markdown, and builds a searchable index.
2. **`packages/mcp-server`** — MCP server using the core library. Reads from the *calling project's* `bun-types` at runtime, falling back to a bundled snapshot.
3. **`packages/skills-generator`** — Build script that groups docs into ~25 skill categories and emits `SKILL.md` files.

## License

MIT — see [LICENSE](./LICENSE).

Documentation content sourced from [`bun-types`](https://github.com/oven-sh/bun/tree/main/packages/bun-types) (MIT, © Jarred Sumner and Bun contributors).