Skip to content

CLAUDE.md

Latest commit

 

History

History
71 lines (56 loc) · 2.32 KB

CLAUDE.md

File metadata and controls

71 lines (56 loc) · 2.32 KB
Raw

CCPlugin — AI Agent Instructions

This is a Claude Code plugin that packages workspace hooks, skills, agents, and an MCP server for distribution.

Beads Issue Tracker

Uses bd (beads) for issue tracking. Run bd prime for workflow context.

Stack

  • Language: TypeScript + Node.js
  • Build: tsup (ESM + CJS output)
  • MCP: @modelcontextprotocol/sdk
  • Package Manager: pnpm
  • Testing: Vitest

Build & Test

pnpm install
pnpm build          # Compile TypeScript → dist/
pnpm dev            # Watch mode
pnpm type-check     # TypeScript check (no emit)
pnpm test           # Run Vitest tests

Architecture

CCPlugin/
├── plugin.json          # Plugin manifest (name, version, components)
├── package.json         # Node.js package
├── tsup.config.ts       # Build config
├── src/
│   ├── index.ts         # Library exports
│   ├── cli.ts           # CLI entry point (install/uninstall/status)
│   ├── mcp/
│   │   └── server.ts    # MCP server (workspace management tools)
│   ├── hooks/           # TypeScript hooks (compiled to dist/)
│   ├── skills/          # Skill .md files (bundled from workspace)
│   ├── agents/          # Agent .md files (bundled from workspace)
│   └── utils/           # Shared utilities (beads, workspace, config)
├── scripts/
│   ├── install.sh       # Install plugin to a workspace
│   ├── uninstall.sh     # Remove plugin from a workspace
│   └── bundle.js        # Copy skills/agents from workspace into src/
└── dist/                # Compiled output (git-ignored)

MCP Server Tools

Tool Description
workspace_status Show git + beads health for all projects
beads_ready List ready-to-work issues
beads_active List in-progress issues
project_list List workspace projects
sync_workspace Run sync-all.sh across all projects

Install to Workspace

pnpm install-plugin              # Install to default workspace
pnpm install-plugin -- /path/to/workspace  # Install to custom path

Conventions

  • TypeScript strict mode + exactOptionalPropertyTypes
  • All hooks must be non-fatal (never block Claude Code on error)
  • MCP server tools should return text content, never throw