-
Notifications
You must be signed in to change notification settings - Fork 16
Agent Brain Plugin Research
Feature: 114-agent-brain-plugin Date: 2025-01-31
Decision: Use full marketplace.json format with commands/, agents/, skills/ folders
Rationale:
- The spec requires separate slash commands (not subcommands), which requires the full plugin format
- Agents for proactive assistance require the agents/ folder
- Skills for reference documentation require the skills/ folder
- marketplace.json provides full manifest capabilities
Alternatives Considered:
- Simple plugin.json format: Rejected - doesn't support explicit commands or agents
- Skill-only approach: Rejected - user requested explicit commands for discoverability
Source: ~/.claude/skills/creating-plugin-from-skill/SKILL.md and references/commands-agents.md
Decision: Use markdown files with YAML frontmatter
Format:
---
name: agent-brain-search
description: Search indexed documentation using hybrid retrieval
parameters:
- name: query
description: The search query text
required: true
- name: top-k
description: Number of results to return
required: false
default: 5
skills:
- using-agent-brain
---
# Agent Brain Search
[Command instructions for Claude...]Rationale:
- YAML frontmatter defines command metadata (name, description, parameters)
- Markdown body provides detailed instructions for Claude
-
skills:field links to reference skills for domain knowledge
Source: ~/.claude/skills/creating-plugin-from-skill/references/commands-agents.md
Decision: Use markdown files with triggers array in frontmatter
Format:
---
name: search-assistant
description: Proactively offers to search documentation
triggers:
- pattern: "search.*docs|find.*documentation"
type: message_pattern
- pattern: "how do I search"
type: keyword
skills:
- using-agent-brain
---
# Search Assistant Agent
[Agent behavior instructions...]Rationale:
- Triggers define when agent activates (patterns, keywords, file mentions)
- Linked skills provide domain knowledge
- Natural language interaction without requiring exact commands
Source: ~/.claude/skills/creating-plugin-from-skill/references/commands-agents.md
Decision: Use SKILL.md with references/ folder
Format:
---
name: using-agent-brain
description: |
Agent Brain document search with BM25 keyword, semantic vector, and hybrid retrieval modes.
Use when asked to "search documentation", "query domain", "find in docs".
license: MIT
metadata:
version: 1.3.0
category: ai-tools
author: Spillwave
---
# Using Agent Brain Skill
[Core instructions, quick start, best practices...]Rationale:
- SKILL.md provides main instructions (loaded when skill triggers)
- references/ folder contains detailed documentation (loaded on demand)
- Description field determines when Claude invokes the skill
Source: ~/.claude/skills/skill-creator/SKILL.md
Decision: Use improving-skills workflow with iterative grading
Process:
- Create initial skill using skill-creator best practices
- Grade with improving-skills rubric
- Identify issues and implement fixes
- Re-grade until 95% score achieved
Grading Categories (from improving-skills skill):
- Progressive Disclosure Architecture (PDA)
- Trigger accuracy and description quality
- Reference file organization
- Workflow clarity and error handling
- Best practices compliance
Target: 95% score for both using-agent-brain and agent-brain-setup skills
Source: ~/.claude/skills/improving-skills/SKILL.md
Decision: Migrate existing using-agent-brain skill content with enhancements
Current skill location: agent-brain-skill/using-agent-brain/
Migration approach:
- Copy existing SKILL.md content as base
- Copy existing references/ folder content
- Update for new plugin structure
- Add any missing content for command/agent integration
Existing references to migrate:
- hybrid-search-guide.md
- bm25-search-guide.md
- vector-search-guide.md
- api_reference.md
- server-discovery.md
- troubleshooting-guide.md
- integration-guide.md
Source: Repository agent-brain-skill/using-agent-brain/
Decision: Map each plugin command to underlying CLI command
| Plugin Command | CLI Command | Purpose |
|---|---|---|
/agent-brain-search |
agent-brain query --mode hybrid |
Hybrid search |
/agent-brain-semantic |
agent-brain query --mode vector |
Vector search |
/agent-brain-keyword |
agent-brain query --mode bm25 |
BM25 search |
/agent-brain-install |
pip install agent-brain-rag agent-brain-cli |
Install packages |
/agent-brain-setup |
Guided flow calling multiple commands | Complete setup |
/agent-brain-config |
Environment variable guidance | API key config |
/agent-brain-init |
agent-brain init |
Project init |
/agent-brain-verify |
agent-brain status |
Verify installation |
/agent-brain-start |
agent-brain start --daemon |
Start server |
/agent-brain-stop |
agent-brain stop |
Stop server |
/agent-brain-status |
agent-brain status |
Check status |
/agent-brain-list |
agent-brain list |
List instances |
/agent-brain-index |
agent-brain index <path> |
Index documents |
/agent-brain-reset |
agent-brain reset --yes |
Clear index |
/agent-brain-help |
Display command list | Show help |
Source: Repository agent-brain-cli/ and existing skill documentation
Decision: Create new GitHub repository for plugin
Repository name: agent-brain-plugin (or agent-brain-agentic-plugin)
Organization: SpillwaveSolutions
Installation URL: https://github.com/SpillwaveSolutions/agent-brain-plugin
Plugin installation (user perspective):
cd ~/.claude/plugins
git clone https://github.com/SpillwaveSolutions/agent-brain-plugin.gitSource: ~/.claude/skills/creating-plugin-from-skill/SKILL.md
All technical clarifications have been resolved through research. No remaining NEEDS CLARIFICATION items.
- Phase 1: Create data-model.md with entity definitions
- Phase 1: Create contracts/ with command and agent schemas
- Phase 1: Create quickstart.md for developer onboarding
- Update agent context with new technology decisions
- Design-Architecture-Overview
- Design-Query-Architecture
- Design-Storage-Architecture
- Design-Class-Diagrams
- GraphRAG-Guide
- Agent-Skill-Hybrid-Search-Guide
- Agent-Skill-Graph-Search-Guide
- Agent-Skill-Vector-Search-Guide
- Agent-Skill-BM25-Search-Guide
Search
Server
Setup
- Pluggable-Providers-Spec
- GraphRAG-Integration-Spec
- Agent-Brain-Plugin-Spec
- Multi-Instance-Architecture-Spec