Agent Playbook

https://github.com/zhaono1/agent-playbook
Admin
Agent Playbook is a comprehensive collection of reusable skills, prompt patterns, and workflow...
Tokens:68,930
Snippets:1,058
Trust Score:7.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Workflow Configuration: Start Small

Source: https://github.com/zhaono1/agent-playbook/blob/main/docs/automation-best-practices.md

Illustrates a good practice of starting with simple automation steps and gradually adding complexity, contrasting with an overly complex initial setup.

```yaml
# ❌ 不好：一开始就做全自动化
workflow: full_automation  # 太复杂，难以调试

# ✅ 好：从简单自动化开始
workflow:
  - step_1: auto_save_session
  - step_2: trigger_reflection  # 后续添加
```

--------------------------------

### Example Usage Prompts

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/documentation-engineer/README.md

These are example prompts to initiate documentation generation with the skill.

```text
You: Write documentation for this API
You: Create a README
You: Document this code
```

--------------------------------

### Example: Get Skill Details

Source: https://github.com/zhaono1/agent-playbook/blob/main/mcp-server/README.md

Demonstrates a user query to retrieve detailed information about a specific skill, 'prd-planner', from the agent-playbook MCP server.

```text
You: Tell me about the prd-planner skill

Claude: [get_skill skill_name="prd-planner"]

Returns: Full description, allowed tools, hooks
```

--------------------------------

### Install Create PR Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/create-pr/README.md

Create a symbolic link to install the skill in the global skills directory.

```bash
# Create symbolic link to global skills directory
ln -s ~/Documents/code/GitHub/agent-playbook/skills/create-pr/SKILL.md ~/.claude/skills/create-pr.md
```

--------------------------------

### README Structure Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/documentation-engineer/SKILL.md

Provides a standard markdown structure for a project's README file, covering essential sections like Quick Start, Installation, Usage, and Contributing.

```markdown
# Project Name

Brief description (what it does, why it exists)

## Quick Start

Installation and usage in 3 steps or less.

## Installation

Detailed installation instructions.

## Usage

Examples of common usage patterns.

## Configuration

Environment variables and configuration options.

## Development

How to run tests, build, and develop locally.

## Contributing

Guidelines for contributors.

## License

License information.
```

--------------------------------

### CI/CD Pipeline Commands

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/deployment-engineer/README.md

Examples of conversational commands to interact with CI/CD functionalities. Use these to initiate setup, creation, or configuration of deployment pipelines.

```text
You: Set up CI/CD
You: Create deployment pipeline
You: Configure GitHub Actions
```

--------------------------------

### Install PRD Planner Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/prd-planner/README.md

Create a symbolic link to install the PRD Planner skill into the global skills directory.

```bash
# Create symbolic link to global skills directory
ln -s ~/Documents/code/GitHub/agent-playbook/skills/prd-planner/SKILL.md ~/.claude/skills/prd-planner.md
```

--------------------------------

### Structured Logging Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/deployment-engineer/SKILL.md

Example of structured logging for deployment events, including version, environment, and timestamp.

```typescript
// Structured logging
logger.info('Deployment started', {
  version: process.env.VERSION,
  environment: process.env.NODE_ENV,
  timestamp: new Date().toISOString(),
});
```

--------------------------------

### Schema Documentation Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-documenter/SKILL.md

Demonstrates best practices for documenting schemas in OpenAPI, including using references, descriptions, formats, examples, and marking required fields.

```yaml
components:
  schemas:
    User:
      type: object
      required:
        - id
        - email
      properties:
        id:
          type: string
          format: uuid
          description: Unique user identifier
          example: "550e8400-e29b-41d4-a716-446655440000"
        email:
          type: string
          format: email
          description: User's email address
          example: "user@example.com"
        createdAt:
          type: string
          format: date-time
          description: Account creation timestamp
```

--------------------------------

### Multi-Skill Workflow Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/skill-router/README.md

Example demonstrating a multi-skill workflow for a complex task like building an API from scratch. The router suggests a sequence of skills to accomplish the project.

```text
You: "I'm building a new API from scratch"

Skill Router: For a complete API project, I recommend using multiple skills:

1. api-designer - Design your API structure and endpoints
2. api-documenter - Create OpenAPI/Swagger documentation
3. test-automator - Set up automated API testing
4. code-reviewer - Review your implementation

Shall we start with api-designer?
```

--------------------------------

### Create PR Integration Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/auto-trigger/SKILL.md

Example of 'create-pr' skill front matter, including an 'after_complete' hook to trigger 'session-logger' upon PR creation.

```yaml
---
name: create-pr
description: Creates pull requests with bilingual documentation updates...
allowed-tools: Read, Write, Edit, Bash, Grep, AskUserQuestion
hooks:
  after_complete:
    - trigger: session-logger
      mode: auto
      context: "PR created: {pr_title}"
---
```

--------------------------------

### Verify Agent Playbook Installation

Source: https://github.com/zhaono1/agent-playbook/blob/main/README.md

Lists the installed skills in the global directories for Claude, Codex, and Gemini to verify the installation.

```bash
ls -la ~/.claude/skills/
ls -la ~/.codex/skills/
ls -la ~/.gemini/skills/
```

--------------------------------

### Install Session Logger Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/session-logger/README.md

Create a symbolic link to the global skills directory to install the session logger.

```bash
# Create symbolic link to global skills directory
ln -s ~/Documents/code/GitHub/agent-playbook/skills/session-logger/SKILL.md ~/.claude/skills/session-logger.md
```

--------------------------------

### Example 1: Adding a New Skill Input

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/create-pr/README.md

Example input prompt for adding a new skill. The skill will automatically update both README files, commit, push, and create a PR.

```bash
"I've created a new skill called skill-router. Please create a PR."
```

--------------------------------

### Example: List All Skills

Source: https://github.com/zhaono1/agent-playbook/blob/main/mcp-server/README.md

Demonstrates a user query to list all available skills from the agent-playbook MCP server.

```text
You: What skills are available?

Claude: I'll check the agent-playbook MCP server...

[list_skills call returns all skills with categories]
```

--------------------------------

### Changelog Entry Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/create-pr/SKILL.md

Example format for adding entries to the CHANGELOG.md file. Use this to document significant changes, additions, or fixes related to skills.

```markdown
## [Version] - YYYY-MM-DD

### Added
- New skill: skill-name

### Fixed
- Fixed issue in skill-name

### Changed
- Updated skill-name with new features
```

--------------------------------

### PRD Planner Integration Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/auto-trigger/SKILL.md

Example of 'prd-planner' skill front matter, demonstrating 'after_complete' hooks to trigger 'self-improving-agent' and 'session-logger'.

```yaml
---
name: prd-planner
description: Creates PRDs using persistent file-based planning...
allowed-tools: Read, Write, Edit, Bash, Grep, Glob, AskUserQuestion, WebSearch
hooks:
  after_complete:
    - trigger: self-improving-agent
      mode: background
      context: "PRD created at {prd_file}"
    - trigger: session-logger
      mode: auto
      context: "PRD creation complete"
---
```

--------------------------------

### Install MCP Server Dependencies

Source: https://github.com/zhaono1/agent-playbook/blob/main/mcp-server/README.md

Navigate to the mcp-server directory and install Node.js dependencies using npm.

```bash
cd mcp-server
npm install
```

--------------------------------

### Install Skill Router

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/skill-router/README.md

Create a symbolic link to the global skills directory to install the Skill Router. Ensure the path to your local agent-playbook skills directory is correct.

```bash
ln -s ~/Documents/code/GitHub/agent-playbook/skills/skill-router/SKILL.md ~/.claude/skills/skill-router.md
```

--------------------------------

### Install Figma Designer Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/figma-designer/README.md

Symbolically link the skill to your Claude Code skills directory for installation.

```bash
ln -s ~/agent-playplaybook/skills/figma-designer/SKILL.md ~/.claude/skills/figma-designer.md
```

--------------------------------

### Install PRD Implementation Precheck Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/prd-implementation-precheck/README.md

Create a symbolic link to install the skill in the global skills directory. This makes the skill accessible for use.

```bash
# Create symbolic link to global skills directory
ln -s ~/Documents/code/GitHub/agent-playbook/skills/prd-implementation-precheck/SKILL.md ~/.claude/skills/prd-implementation-precheck.md
```

--------------------------------

### Header Versioning Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-designer/SKILL.md

Demonstrates API versioning using the Accept header.

```http
GET /users
Accept: application/vnd.myapi.v2+json
```

--------------------------------

### Initialize Agent Playbook

Source: https://github.com/zhaono1/agent-playbook/blob/main/packages/agent-playbook/README.md

Use this command to initialize the agent-playbook. The `--project` flag is for project-only setup.

```bash
pnpm dlx @codeharbor/agent-playbook init
# or
npm exec -- @codeharbor/agent-playbook init
```

```bash
pnpm dlx @codeharbor/agent-playbook init --project
```

--------------------------------

### Developer Handoff Documentation Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/figma-designer/SKILL.md

Example markdown structure for developer handoff, detailing design files, tokens, component library, and assets.

```markdown
## Developer Handoff

### Design Files
- Figma: {url}
- Design Spec: {link}

### Design Tokens
- Generated: `tokens.ts`
- Color palette: `colors.ts`
- Typography: `typography.ts`

### Component Library
- Storybook: {url}
- Component docs: {link}

### Assets
- Icons: {folder}
- Images: {folder}
- Exports: {format}
```

--------------------------------

### Skill Hook Configuration Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/auto-trigger/SKILL.md

Example of how to add auto-trigger capabilities to a skill's front matter using 'before_start', 'after_complete', and 'on_error' hooks.

```yaml
---
name: my-skill
description: Skill description
allowed-tools: Read, Write, Edit
hooks:
  before_start:
    - trigger: session-logger
      mode: auto
      context: "Start {skill_name}"
  after_complete:
    - trigger: self-improving-agent
      mode: background
    - trigger: session-logger
      mode: auto
  on_error:
    - trigger: self-improving-agent
      mode: background
---
```

--------------------------------

### URL Versioning Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-designer/SKILL.md

Illustrates the recommended approach for API versioning using URL paths.

```http
/api/v1/users
/api/v2/users
```

--------------------------------

### Install Long Task Coordinator Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/long-task-coordinator/README.md

Symlinks the long-task-coordinator skill into common agent skill directories for installation.

```bash
ln -s /path/to/agent-playbook/skills/long-task-coordinator ~/.claude/skills/long-task-coordinator
ln -s /path/to/agent-playbook/skills/long-task-coordinator ~/.codex/skills/long-task-coordinator
ln -s /path/to/agent-playbook/skills/long-task-coordinator ~/.gemini/skills/long-task-coordinator
```

--------------------------------

### Direct State Monitoring Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/self-improving-agent/SKILL.md

TypeScript example demonstrating direct state monitoring using `usePrevious` hook, contrasted with less effective callback chains.

```typescript
// ✅ Do: Direct state monitoring
const prevPendingCount = usePrevious(pendingCount);
```

--------------------------------

### Endpoint Documentation Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-documenter/SKILL.md

An example of documenting a specific API endpoint, including parameters, responses, and descriptions, within an OpenAPI specification.

```yaml
/users/{id}:
  get:
    summary: Get a user by ID
    operationId: getUserById
    description: Retrieves a single user by their unique identifier
    tags:
      - users
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The user ID
    responses:
      '200':
        description: User found
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      '404':
        description: User not found
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Error'
```

--------------------------------

### Initialize Agent Playbook Skills and Hooks

Source: https://context7.com/zhaono1/agent-playbook/llms.txt

Installs bundled skills as symlinks or copies, sets up Claude Code lifecycle hooks, and configures the skill state registry. Use `--project` for project-local installs and `--copy` to avoid symlinks.

```bash
pnpm dlx @codeharbor/agent-playbook init
```

```bash
pnpm dlx @codeharbor/agent-playbook init --project
```

```bash
pnpm dlx @codeharbor/agent-playbook init --copy --overwrite --session-dir ./logs/sessions
```

```bash
pnpm dlx @codeharbor/agent-playbook init --dry-run
```

```bash
# Expected output:
# Init complete.
# - Claude skills: /Users/you/.claude/skills
# - Codex skills:  /Users/you/.codex/skills
# - Gemini skills: /Users/you/.gemini/skills
# - Hooks: enabled
# - Linked skills: 22
```

--------------------------------

### Example QA Plan Prompts

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/qa-expert/README.md

Use these prompts to initiate QA planning and strategy discussions with the QA Expert skill.

```text
You: Create a QA plan
You: Set up quality gates
You: What tests should I write?
```

--------------------------------

### Figma Visual Specification Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/figma-designer/README.md

An example of a visual specification generated for a 'Login' screen, illustrating layout structure and element hierarchy.

```markdown
## Screen: Login

### Layout Structure
```
┌─────────────────────────────────────────┐
│           Logo                          [Icon] │
├─────────────────────────────────────────┤
│  Welcome back                            │
│  Sign in to continue                    │
├─────────────────────────────────────────┤
│  Email                    [✓]           │
│  ┌────────────────────────────────┐    │
│  └────────────────────────────────┘    │
├─────────────────────────────────────────┤
│  Password                [👁️]           │
│  ┌────────────────────────────────┐    │
│  └────────────────────────────────┘    │
├─────────────────────────────────────────┤
│         Forgot password?               │
├─────────────────────────────────────────┤
│  [      Sign In        ]               │
└─────────────────────────────────────────┘
```
```

--------------------------------

### Ambiguous Request Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/skill-router/README.md

Example of how the Skill Router handles an ambiguous request by asking clarifying questions. This helps narrow down the user's needs before recommending a skill.

```text
You: "Use a skill to help with my project"

Skill Router: I'd like to understand your needs better:
- What type of task are you working on?
- Are you designing, coding, testing, or documenting?
- What's the primary goal?

[Based on your answers, I'll recommend the right skill]
```

--------------------------------

### Manual Skill Invocation Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/README.md

This example demonstrates how to manually invoke a skill by explicitly asking Claude to use it. The 'prd-planner' skill is shown activating automatically based on the user's request.

```text
You: Create a PRD for a new authentication feature
```

--------------------------------

### REST API Pagination Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-designer/SKILL.md

Demonstrates how to implement pagination in a REST API using query parameters and includes a sample response structure.

```http
GET /users?page=1&page_size=20

Response:
{
  "data": [...],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total": 100,
    "total_pages": 5
  }
}
```

--------------------------------

### Repair Agent Playbook Installation

Source: https://context7.com/zhaono1/agent-playbook/llms.txt

Re-applies missing hooks and skill links by selectively running the install logic. Use `--overwrite` to force re-linking of all skills.

```bash
apb repair
# Init complete.
# - Hooks: enabled
# - Linked skills: 0   (already linked, nothing re-created)
```

```bash
apb repair --overwrite
# Forces re-link of all skills even if they already exist
```

--------------------------------

### Install Planning with Files Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/planning-with-files/SKILL.md

Use this command to create a symbolic link for the planning-with-files skill in your Claude configuration directory.

```bash
ln -s /path/to/agent-playbook/skills/planning-with-files ~/.claude/skills/planning-with-files
```

--------------------------------

### Add Individual Agent Playbook Skill

Source: https://context7.com/zhaono1/agent-playbook/llms.txt

Installs a single skill, either from the bundled set by name or from a local path. Specify scope and target for installation.

```bash
# Add a bundled skill globally to Claude
apb skills add code-reviewer --scope global --target claude
```

```bash
# Add a local custom skill to the project scope
apb skills add ./my-skills/custom-reviewer --scope project --target claude
```

--------------------------------

### Example: Check Skill Hooks

Source: https://github.com/zhaono1/agent-playbook/blob/main/mcp-server/README.md

Demonstrates a user query to check the auto-trigger hooks for a specific skill, 'prd-planner', after its completion.

```text
You: What happens after prd-planner completes?

Claude: [get_skill_hooks skill_name="prd-planner"]

Returns: Full hook configuration, including `after_complete`
```

--------------------------------

### Example 2: Bug Fix Input

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/create-pr/README.md

Example input prompt for a bug fix. The skill will analyze the change, determine if documentation updates are needed, and create a PR accordingly.

```bash
"I fixed a typo in debugger skill. Create a PR."
```

--------------------------------

### Example: Search for a Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/mcp-server/README.md

Demonstrates a user query to search for skills related to debugging on the agent-playbook MCP server.

```text
You: I need help with debugging

Claude: Let me search for debugging skills...

[search_skills query="debug" returns debugger skill]
```

--------------------------------

### Session Log File Structure Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/session-logger/SKILL.md

This illustrates the directory structure and naming convention for session log files.

```treeview
sessions/
├── README.md                      # This file
├── 2025-01-11-skill-router.md     # Session about skill-router
├── 2025-01-11-prd-planner.md      # Session about PRD planner
└── 2025-01-12-refactoring.md      # Session about refactoring

```

--------------------------------

### list_skills

Source: https://context7.com/zhaono1/agent-playbook/llms.txt

Lists every installed skill with name, description, category, file path, and allowed tools. Optionally filtered by category.

```APIDOC
## MCP Tool: `list_skills` — Enumerate all skills

Lists every installed skill with name, description, category, file path, and allowed tools. Optionally filtered by category.

### Request Example
```json
{
  "tool": "list_skills",
  "arguments": { "category": "core" }
}
```

### Response Example
```json
[
  {
    "name": "code-reviewer",
    "description": "Reviews pull requests and code changes for quality, security, and best practices.",
    "category": "core",
    "path": "/path/to/skills/code-reviewer/SKILL.md",
    "allowed_tools": ["Read", "Grep", "Glob", "Bash", "WebFetch", "WebSearch"]
  }
]
```
```

--------------------------------

### List All Skills with Category Filter

Source: https://context7.com/zhaono1/agent-playbook/llms.txt

Use the `list_skills` tool to enumerate all installed skills. Optionally filter by category.

```json
{
  "tool": "list_skills",
  "arguments": { "category": "core" }
}
```

```json
[
  {
    "name": "code-reviewer",
    "description": "Reviews pull requests and code changes for quality, security, and best practices.",
    "category": "core",
    "path": "/path/to/skills/code-reviewer/SKILL.md",
    "allowed_tools": ["Read", "Grep", "Glob", "Bash", "WebFetch", "WebSearch"]
  },
  {
    "name": "commit-helper",
    "description": "Helps write Git commit messages following the Conventional Commits specification.",
    "category": "core",
    "path": "/path/to/skills/commit-helper/SKILL.md",
    "allowed_tools": ["Read", "Write", "Edit", "Bash", "Grep"]
  }
]
```

--------------------------------

### Authentication Documentation Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-documenter/SKILL.md

Shows how to document authentication requirements, specifically Bearer JWT authentication, within an OpenAPI specification.

```yaml
security:
  - bearerAuth: []

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use your JWT token from /auth/login
```

--------------------------------

### Auto-Trigger Configuration Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/workflow-orchestrator/SKILL.md

Defines hooks for 'after_complete' and 'on_error' events, specifying skills to trigger and their execution modes.

```yaml
hooks:
  after_complete:
    - trigger: self-improving-agent
      mode: background
    - trigger: session-logger
      mode: auto
  on_error:
    - trigger: self-improving-agent
      mode: background
```

--------------------------------

### Direct Skill Match Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/skill-router/README.md

Example of a direct skill match where the user's request clearly maps to a specific skill. The router recommends the 'code-reviewer' skill for pull request reviews.

```text
You: "I need to review this pull request"

Skill Router: Recommended Skill: code-reviewer
This skill is designed for reviewing PRs and code changes for quality,
security, and best practices.

Would you like me to activate this skill?
```

--------------------------------

### RESTful Resource Design Examples

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-designer/SKILL.md

Illustrates good and bad practices for designing RESTful API endpoints based on resource orientation.

```http
GET    /users          # List users
POST   /users          # Create user
GET    /users/{id}     # Get specific user
PATCH  /users/{id}     # Update user
DELETE /users/{id}     # Delete user
```

```http
POST   /getUsers       # Should be GET
POST   /users/create  # Redundant
GET    /users/get/{id} # Redundant
```

--------------------------------

### API Documenter Skill Usage

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-documenter/README.md

These are example prompts to invoke the API Documenter skill for generating documentation.

```text
You: Document this API
```

```text
You: Create OpenAPI spec
```

```text
You: Generate API documentation
```

--------------------------------

### Hook Implementation in Skills

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/workflow-orchestrator/SKILL.md

Example of how to add auto-trigger hooks to a skill's SKILL.md file for 'after_complete' and 'on_error' events.

```markdown
## Auto-Trigger (After Completion)

When this skill completes, automatically trigger:

```yaml
hooks:
  after_complete:
    - trigger: skill-name
      mode: auto|background|ask_first
      context: "relevant context"
  on_error:
    - trigger: self-improving-agent
      mode: background
```
```

--------------------------------

### REST API Filtering and Sorting Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-designer/SKILL.md

Shows how to use query parameters for filtering and sorting resources in a REST API.

```http
GET /users?status=active&sort=-created_at,name

# -created_at = descending
# name = ascending
```

--------------------------------

### Generating Component Library Structure

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/figma-designer/SKILL.md

Example directory structure for a component library. This is used when generating a design system with reusable components.

```bash
src/components/
├── Button/
│   ├── Button.tsx
│   ├── Button.test.tsx
│   └── Button.stories.tsx
├── Input/
├── Card/
└── tokens.ts
```

--------------------------------

### Production Configuration Object

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/deployment-engineer/SKILL.md

Defines the production configuration using environment variables. This example uses TypeScript and assumes environment variables are pre-loaded.

```typescript
// config/production.ts
export default {
  database: {
    url: process.env.DATABASE_URL,
    poolSize: 20,
  },
  redis: {
    url: process.env.REDIS_URL,
  },
};
```

--------------------------------

### Good Commit Message Example: Documentation

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/commit-helper/SKILL.md

Example of a commit message for documentation-only changes.

```markdown
docs: update API documentation with new endpoints

Added documentation for the v2 user management endpoints
including request/response examples and error codes.
```

--------------------------------

### Generating Design Specification Document

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/figma-designer/SKILL.md

Example command to generate a design specification document. This is useful for creating a visual spec for components.

```bash
docs/{feature}-design-spec.md
```

--------------------------------

### Environment Variables Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/deployment-engineer/SKILL.md

Illustrates environment variables for production and development configurations. Ensure sensitive information like API keys and database URLs are managed securely.

```bash
# Production
NODE_ENV=production
DATABASE_URL=postgresql://...
API_KEY=sk-...
SENTRY_DSN=https://example.com/123

# Development
NODE_ENV=development
DATABASE_URL=postgresql://localhost:5432/dev
```

--------------------------------

### Get Diff

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/code-reviewer/SKILL.md

Use this bash command to get the full diff between the main branch and the current HEAD.

```bash
git diff main...HEAD
```

--------------------------------

### Call Chain Documentation Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/architecting-solutions/SKILL.md

Illustrates how to document a call chain for better understanding of code flow. Include file paths and line numbers for each step.

```text
onRefresh() → navigation.goBack() → Dashboard focused
  → usePromiseResult (revalidateOnFocus: true) fires
  → refreshItems() → handleRefresh()
  → fetchItems() + refreshSummary() + refreshMetrics()
```

--------------------------------

### Security Auditor Skill Usage Examples

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/security-auditor/README.md

These are example prompts to initiate a security audit using the Security Auditor skill.

```text
Audit this code for security issues
```

```text
Check for vulnerabilities
```

```text
Is this code secure?
```

--------------------------------

### Usage Examples for Performance Engineer Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/performance-engineer/README.md

These are example prompts to interact with the Performance Engineer skill for code optimization and analysis.

```text
You: Optimize this code
You: Why is this slow?
You: Profile this application
```

--------------------------------

### Good Commit Message Example: Refactor

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/commit-helper/SKILL.md

Example of a commit message for a code refactoring, explaining the simplification and reuse of logic.

```markdown
refactor(user): simplify profile update logic

Extracted common validation logic into a reusable function
to reduce code duplication across profile update endpoints.
```

--------------------------------

### Good Commit Message Example: Bug Fix

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/commit-helper/SKILL.md

Example of a commit message for a bug fix, detailing the issue and its resolution.

```markdown
fix(api): resolve race condition in user creation

The concurrent user creation requests could result in duplicate
email entries. Added unique constraint and proper error handling.

Fixes #456
```

--------------------------------

### Self-Improving Agent Integration Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/auto-trigger/SKILL.md

Example of 'self-improving-agent' skill front matter, showing 'after_complete' and 'on_error' hooks for triggering 'create-pr' and 'session-logger'.

```yaml
---
name: self-improving-agent
description: Universal self-improvement that learns from all skill experiences...
allowed-tools: Read, Write,Edit, Bash, Grep, Glob, WebSearch
hooks:
  after_complete:
    - trigger: create-pr
      mode: ask_first
      condition: skills_modified
    - trigger: session-logger
      mode: auto
      context: "Self-improvement cycle complete"
  on_error:
    - trigger: self-improving-agent
      mode: background
---
```

--------------------------------

### PRD Precheck Report Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/prd-implementation-precheck/README.md

An example of the markdown output generated by the precheck skill. It includes sections for intent, blockers, questions, risks, and recommendations.

```markdown
## Precheck Report for {PRD}

### Intent
{1-2 sentence summary}

### Blockers
- [ ] Blocker 1
- [ ] Blocker 2

### Questions
1. Question about scope?
2. Question about dependencies?

### Risks
- Risk 1
- Risk 2

### Recommendation
Proceed as-is, or update the PRD first?
```

--------------------------------

### Minimum Skill Structure (File Paths)

Source: https://context7.com/zhaono1/agent-playbook/llms.txt

Illustrates the essential directory and file structure required for a new skill, including mandatory and recommended files.

```text
skills/my-new-skill/
├── SKILL.md        ← required: front-matter + skill body
├── README.md       ← recommended: usage examples
└── references/     ← optional: templates, checklists, examples
    └── guide.md

```

--------------------------------

### New Feature Implementation Checklist

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/architecting-solutions/SKILL.md

A step-by-step guide for implementing new features, emphasizing understanding similar implementations, identifying reusable patterns, and defining a clear design and state management approach.

```plaintext
1. Read similar feature implementations
2. Identify reusable patterns
3. Design component hierarchy
4. Define state management approach
5. Specify API integration points
6. List all new files to create
7. List all existing files to modify
```

--------------------------------

### Example Prompts for Solution Design

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/architecting-solutions/README.md

Use these prompts to initiate discussions on designing technical solutions and architectures. They cover various aspects like new systems, multi-tenancy, and data migration.

```text
You: Design solution for a new billing system
You: Provide an architecture design for multi-tenant analytics
You: Technical design for a data migration plan
```

--------------------------------

### Agent Playbook Skills Manager Examples

Source: https://github.com/zhaono1/agent-playbook/blob/main/packages/agent-playbook/README.md

These commands demonstrate how to use the agent-playbook skills manager for listing, adding, enabling, and disabling skills. Use `--scope` and `--target` to specify the scope and target platform.

```bash
apb skills list --scope both --target all
```

```bash
apb skills add ./skills/my-skill --scope project --target claude
```

```bash
apb skills disable my-skill --scope project --target claude
```

```bash
apb skills enable my-skill --scope project --target claude
```

--------------------------------

### Figma Design Tokens Example

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/figma-designer/README.md

Example of extracted design tokens including colors, typography, and spacing. This data is useful for maintaining design consistency across platforms.

```typescript
// tokens.ts
export const colors = {
  primary: '#007AFF',
  background: '#FFFFFF',
  surface: '#F5F5F7',
  textPrimary: '#1C1C1E',
  textSecondary: '#8E8E93',
};

export const typography = {
  displayLarge: {
    fontSize: 28,
    fontWeight: '700',
    lineHeight: 34,
  },
  // ...
};

export const spacing = {
  xs: 4,
  sm: 8,
  md: 12,
  lg: 16,
  xl: 24,
  2xl: 32,
};
```

--------------------------------

### Good Commit Message Example: Feature

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/commit-helper/SKILL.md

Example of a well-formatted commit message for a new feature, including type, scope, subject, body, and footer referencing an issue.

```markdown
feat(auth): add OAuth2 login support

Implement OAuth2 authentication flow to allow users to log in
with their Google or GitHub accounts.

This change adds:
- New OAuth2 middleware for handling callbacks
- Updated login UI with social login buttons
- User profile synchronization

Closes #123
```

--------------------------------

### List Installed Agent Playbook Skills

Source: https://context7.com/zhaono1/agent-playbook/llms.txt

Scans and lists installed skills across different scopes (project/global) and targets (Claude/Codex/Gemini). Supports table or JSON output formats.

```bash
# List all skills in all scopes and targets
apb skills list --scope both --target all
```

```bash
# JSON output
apb skills list --scope global --target claude --format json
```

```bash
# Example table output:
# Name                  Target  Scope   Mode  Status  Managed  Source                              Path
# ----                  ------  -----   ----  ------  -------  ------                              ----
# code-reviewer         claude  global  link  ok      yes      /path/to/skills/code-reviewer       ~/.claude/skills/code-reviewer
# commit-helper         claude  global  link  ok      yes      /path/to/skills/commit-helper       ~/.claude/skills/commit-helper
# prd-planner           claude  global  link  ok      yes      /path/to/skills/prd-planner         ~/.claude/skills/prd-planner
```

--------------------------------

### Check Agent Playbook Installation Health

Source: https://context7.com/zhaono1/agent-playbook/llms.txt

Verifies the current installation status of Agent Playbook components. `doctor` additionally exits with a non-zero status code if issues are found.

```bash
apb status
# Agent Playbook Status:
# - Skills source: /path/to/agent-playbook/skills
# - Claude skills count: 22
# - Claude hooks installed: yes
# - Claude manifest present: yes
# - Claude local CLI present: yes
# - Codex config block: yes
```

```bash
apb doctor
# (same output as status)
# No critical issues detected.

# When issues exist:
# Issues detected:
# - Claude hooks not installed
# - missing Claude skill manifest (.agent-playbook.json)
# Exit code: 1
```

--------------------------------

### Self-Correction Example with Marker

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/self-improving-agent/SKILL.md

Provides an example of a self-correction applied to a skill, including a timestamped marker, the original guidance, the reason for correction, and the pattern affected. This helps in tracing and understanding past modifications.

```markdown
<!-- Correction: 2025-01-12 | was: "useMemo for claimable ids" | reason: stale data at click time -->

## Self-Correction: Click-Time Computation

**Issue**: Using useMemo for claimable IDs caused stale data
**Fix**: Compute at click time for always-fresh data
**Pattern**: click_time_vs_open_time_computation
```

--------------------------------

### Basic PRD Creation Prompt

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/prd-planner/README.md

Initiate PRD creation by providing a clear request. The skill will automatically create necessary files and manage the workflow.

```bash
# Simply ask for a PRD
"Create a PRD for user authentication"

# The skill will:
# 1. Create 4 files in docs/
# 2. Gather requirements (saved to notes)
# 3. Research best practices (saved to notes)
# 4. Design architecture (saved to notes)
# 5. Synthesize into PRD (reads from notes)
# 6. Write technical design (reads from notes)
# 7. Validate with you
```

--------------------------------

### Initialize PRD Task Plan Template

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/prd-planner/SKILL.md

Use this markdown template to initialize the PRD task plan file. It outlines the goal, owner, phases, status, and a progress log for tracking PRD creation.

```markdown
# PRD Task Plan: {Feature Name}

## Goal
Create a PRD and technical design for {feature description}.

## Owner
{User name/role}

## Phases
- [x] Phase 1: Initialize files ✓
- [ ] Phase 2: Gather requirements (CURRENT)
- [ ] Phase 3: Research & analysis
- [ ] Phase 4: Design solution
- [ ] Phase 5: Write PRD
- [ ] Phase 6: Write technical design
- [ ] Phase 7: Validate & finalize

## Status
**Currently in Phase 2** - Gathering requirements from user

## Progress Log
- {timestamp} - Phase 1 complete: Files initialized

```

--------------------------------

### Typical Workflow with Figma Designer

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/figma-designer/README.md

Illustrates a typical workflow integrating the figma-designer skill with other skills like prd-planner and implementation tools.

```text
Figma URL → figma-designer → Visual Specs
                                ↓
                           prd-planner → PRD
                                ↓
                           implementation → Code
                                ↓
                           code-reviewer → Quality Check
```

--------------------------------

### Rate Limiting Response Headers

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/api-designer/SKILL.md

Example of HTTP response headers indicating rate limit status.

```http
HTTP/1.1 200 OK
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1631234567
```

--------------------------------

### Event-Based Trigger for File Creation

Source: https://github.com/zhaono1/agent-playbook/blob/main/docs/automation-best-practices.md

An example of an event-based trigger that activates an agent when a specific file is created.

```yaml
# Event-based: 文件创建时触发
triggers:
  - event: file_created
    file: "docs/{feature}-prd.md"
    action: trigger_self_improving_agent
```

--------------------------------

### Add Agent Playbook Skills to Project

Source: https://github.com/zhaono1/agent-playbook/blob/main/README.md

Sets up project-specific skill directories for Claude, Codex, and Gemini by copying skills into the project's hidden directories.

```bash
mkdir -p .claude/skills .codex/skills .gemini/skills
cp -r /path/to/agent-playbook/skills/* .claude/skills/
cp -r /path/to/agent-playbook/skills/* .codex/skills/
cp -r /path/to/agent-playbook/skills/* .gemini/skills/
```

--------------------------------

### get_skill

Source: https://context7.com/zhaono1/agent-playbook/llms.txt

Returns metadata for a named skill. Pass `include_content: true` to get the full `SKILL.md` content.

```APIDOC
## MCP Tool: `get_skill` — Fetch skill details

Returns metadata for a named skill. Pass `include_content: true` to get the full `SKILL.md` content.

### Request Example
```json
{
  "tool": "get_skill",
  "arguments": {
    "skill_name": "prd-planner",
    "include_content": true
  }
}
```

### Response Example
```json
{
  "name": "prd-planner",
  "description": "Creates PRDs using persistent file-based planning.",
  "allowed_tools": ["Read", "Write", "Edit", "Bash", "Grep", "Glob", "AskUserQuestion", "WebSearch"],
  "hooks": {
    "after_complete": [
      { "trigger": "self-improving-agent", "mode": "background", "reason": "Extract patterns and improve PRD quality" },
      { "trigger": "session-logger", "mode": "auto", "reason": "Save session context" }
    ]
  },
  "full_content": "---\nname: prd-planner\n...",
  "main_content": "# PRD Planner\n\nA PRD creation skill that uses..."
}
```
```

--------------------------------

### Example Commit Message for a New Feature

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/commit-helper/README.md

Demonstrates the expected output for committing a new feature. The message follows the 'feat(scope): description' format.

```text
You: Commit the new user authentication feature

Claude generates:
feat(auth): add OAuth2 login support

Implement OAuth2 authentication flow for Google and GitHub.
Users can now link multiple social accounts to their profile.
```

--------------------------------

### Resource Endpoint

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/documentation-engineer/references/api-template.md

This endpoint allows for operations on resources, supporting GET, POST, PUT, and DELETE methods.

```APIDOC
## GET /resource

### Description
Retrieves a resource.

### Method
GET

### Endpoint
/resource

### Parameters
#### Query Parameters
- **id** (string, required) - Resource identifier

### Response
#### Success Response (200)
- **data** (object) - The resource data

#### Response Example
```json
{
  "data": {}
}
```

## POST /resource

### Description
Creates a new resource.

### Method
POST

### Endpoint
/resource

### Response
#### Success Response (200)
- **data** (object) - The created resource data

#### Response Example
```json
{
  "data": {}
}
```

## PUT /resource

### Description
Updates an existing resource.

### Method
PUT

### Endpoint
/resource

### Parameters
#### Query Parameters
- **id** (string, required) - Resource identifier

### Response
#### Success Response (200)
- **data** (object) - The updated resource data

#### Response Example
```json
{
  "data": {}
}
```

## DELETE /resource

### Description
Deletes a resource.

### Method
DELETE

### Endpoint
/resource

### Parameters
#### Query Parameters
- **id** (string, required) - Resource identifier

### Response
#### Success Response (200)
- **data** (object) - Confirmation of deletion

#### Response Example
```json
{
  "data": {}
}
```

### Errors
- `400` Bad Request
- `401` Unauthorized
- `404` Not Found
```

--------------------------------

### Generate Deployment Configuration Script

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/deployment-engineer/README.md

Use this bash script to generate deployment configuration files for a specified environment. Ensure you have Python installed and the script is executable.

```bash
python scripts/generate_deploy.py <environment>
```

--------------------------------

### Use PRD Implementation Precheck Skill

Source: https://github.com/zhaono1/agent-playbook/blob/main/skills/prd-implementation-precheck/README.md

Initiate the PRD implementation process by providing the path to the PRD file. The skill will then perform a precheck, present findings, and await confirmation before implementation.

```bash
# Ask to implement a PRD
"Implement the PRD at docs/feature-prd.md"

# The skill will:
# 1. Read and analyze the PRD
# 2. Present precheck report with questions
# 3. Wait for your confirmation
# 4. Implement after approval
```
Tokens:
Raw