diff --git a/README.md b/README.md index d118854..1e77064 100644 --- a/README.md +++ b/README.md @@ -62,26 +62,114 @@ Instead of spending days wiring together LLMs, tools, and execution environments ### 🤖 Agents -| Agent | Purpose | MCP Servers | Local Tools | -|-------|---------|-------------|-------------| -| `developer` | **Code Master:** Read, search & edit code. | `webfetch` | *All codebase tools below* | -| `travel-coordinator` | **Trip Planner:** Orchestrates agents. | `kiwi-com-flight-search`
`webfetch` | *Uses 3 sub-agents* | -| `chef` | **Chef:** Recipes from your fridge. | `webfetch` | - | -| `news` | **News Anchor:** Aggregates top stories. | `webfetch` | - | -| `travel` | **Flight Booker:** Finds the best routes. | `kiwi-com-flight-search` | - | -| `simple` | **Chat Buddy:** Vanilla conversational agent. | - | - | -| `github-pr-reviewer` | **PR Reviewer:** Reviews diffs, posts inline comments & summaries. | - | `get_pr_diff`, `get_pr_comments`, `post_review_comment`, `post_general_comment`, `reply_to_review_comment`, `get_pr_metadata` | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AgentPurposeMCP ServersLocal Tools
developerCode Master: Read, search & edit code.webfetchAll codebase tools below
travel-coordinatorTrip Planner: Orchestrates agents.kiwi-com-flight-search
webfetch		Uses 3 sub-agents
chefChef: Recipes from your fridge.webfetch-
newsNews Anchor: Aggregates top stories.webfetch-
travelFlight Booker: Finds the best routes.kiwi-com-flight-search-
simpleChat Buddy: Vanilla conversational agent.--
github-pr-reviewerPR Reviewer: Reviews diffs, posts inline comments & summaries.- +
+ View tools + get_pr_diff
+ get_pr_comments
+ post_review_comment
+ post_general_comment
+ reply_to_review_comment
+ get_pr_metadata +
+
### 📦 Local Tools (Zero External Dependencies) -| Tool | Capability | Example | -|------|------------|---------| -| `find_files` | Fast search via `fd` | `*.py` finds Python files | -| `discover_structure` | Directory tree mapping | Understands project layout | -| `get_file_outline` | AST signature parsing (Python, TS, Go, Rust, Java, C++, PHP) | Extracts classes/functions | -| `read_file_fragment` | Precise file reading | `file.py:10:50` | -| `code_search` | Fast search via `ripgrep` | Global regex search | -| `edit_file` | Safe file editing | Inserts/Replaces lines | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ToolCapabilityExample
find_filesFast search via fd*.py finds Python files
discover_structureDirectory tree mappingUnderstands project layout
get_file_outlineAST signature parsing (Python, TS, Go, Rust, Java, C++, PHP)Extracts classes/functions
read_file_fragmentPrecise file readingfile.py:10:50
code_searchFast search via ripgrepGlobal regex search
edit_fileSafe file editingInserts/Replaces lines
📝 Advanced: edit_file Formats @@ -98,10 +186,27 @@ Instead of spending days wiring together LLMs, tools, and execution environments ### 🌐 MCP Servers (Context Superpowers) -| Server | Purpose | API Key Needed? | -|--------|---------|-----------------| -| `kiwi-com-flight-search` | Search real-time flights | 🟢 No | -| `webfetch` | Extract clean text from URLs & web search | 🟢 No | + + + + + + + + + + + + + + + + + + + + +
ServerPurposeAPI Key Needed?
kiwi-com-flight-searchSearch real-time flights🟢 No
webfetchExtract clean text from URLs & web search🟢 No
--- @@ -109,19 +214,72 @@ Instead of spending days wiring together LLMs, tools, and execution environments The framework supports **10+ LLM providers** out of the box, covering 90%+ of the LLM market: -| Provider | Type | Use Case | -|----------|-------|----------| -| **Anthropic** | Cloud | State-of-the-art reasoning (Claude) | -| **OpenAI** | Cloud | GPT-4, GPT-4.1, o1 series | -| **Azure OpenAI** | Cloud | Enterprise OpenAI deployments | -| **Google GenAI** | Cloud | Gemini models via API | -| **Google Vertex AI** | Cloud | Gemini models via GCP | -| **Groq** | Cloud | Ultra-fast inference | -| **Mistral AI** | Cloud | European privacy-focused models | -| **Cohere** | Cloud | Enterprise RAG and Command models | -| **AWS Bedrock** | Cloud | Anthropic, Titan, Meta via AWS | -| **Ollama** | Local | Run LLMs locally (zero API cost) | -| **Hugging Face** | Cloud | Open models from Hugging Face Hub | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ProviderTypeUse Case
AnthropicCloudState-of-the-art reasoning (Claude)
OpenAICloudGPT-4, GPT-4.1, o1 series
Azure OpenAICloudEnterprise OpenAI deployments
Google GenAICloudGemini models via API
Google Vertex AICloudGemini models via GCP
GroqCloudUltra-fast inference
Mistral AICloudEuropean privacy-focused models
CohereCloudEnterprise RAG and Command models
AWS BedrockCloudAnthropic, Titan, Meta via AWS
OllamaLocalRun LLMs locally (zero API cost)
Hugging FaceCloudOpen models from Hugging Face Hub
**Provider Priority:** Anthropic > Google Vertex > Google GenAI > Azure > Groq > Mistral > Cohere > Bedrock > HuggingFace > Ollama > OpenAI (fallback) @@ -184,19 +342,84 @@ bin/agent.sh chef -i "I have chicken, rice, and soy sauce. What can I make?"
🔑 Required Environment Variables -| Provider | Variable | Required? | Default Model | -|----------|-----------|-------------|---------------| -| **Anthropic** | `ANTHROPIC_API_KEY` | 🟢 **Yes*** | `claude-haiku-4-5-20251001` | -| **OpenAI** | `OPENAI_API_KEY` | 🟢 **Yes*** | `gpt-4o-mini` | -| **Azure OpenAI** | `AZURE_OPENAI_API_KEY`, `AZURE_OPENAI_ENDPOINT` | ⚪ No | `gpt-4o-mini` | -| **Google GenAI** | `GOOGLE_API_KEY` | ⚪ No | `gemini-2.0-flash-exp` | -| **Google Vertex AI** | `GOOGLE_VERTEX_PROJECT_ID` | ⚪ No | `gemini-2.0-flash-exp` | -| **Groq** | `GROQ_API_KEY` | ⚪ No | `llama-3.3-70b-versatile` | -| **Mistral AI** | `MISTRAL_API_KEY` | ⚪ No | `mistral-large-latest` | -| **Cohere** | `COHERE_API_KEY` | ⚪ No | `command-r-plus` | -| **AWS Bedrock** | `AWS_PROFILE` or `AWS_ACCESS_KEY_ID` | ⚪ No | `anthropic.claude-3-5-sonnet-20241022-v2:0` | -| **Ollama** | `OLLAMA_BASE_URL` | ⚪ No | `llama3.2` | -| **Hugging Face** | `HUGGINGFACEHUB_API_TOKEN` | ⚪ No | `meta-llama/Llama-3.2-3B-Instruct` | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ProviderVariableRequired?Default Model
AnthropicANTHROPIC_API_KEY🟢 Yes*claude-haiku-4-5-20251001
OpenAIOPENAI_API_KEY🟢 Yes*gpt-4o-mini
Azure OpenAIAZURE_OPENAI_API_KEY, AZURE_OPENAI_ENDPOINT⚪ Nogpt-4o-mini
Google GenAIGOOGLE_API_KEY⚪ Nogemini-2.0-flash-exp
Google Vertex AIGOOGLE_VERTEX_PROJECT_ID⚪ Nogemini-2.0-flash-exp
GroqGROQ_API_KEY⚪ Nollama-3.3-70b-versatile
Mistral AIMISTRAL_API_KEY⚪ Nomistral-large-latest
CohereCOHERE_API_KEY⚪ Nocommand-r-plus
AWS BedrockAWS_PROFILE or AWS_ACCESS_KEY_ID⚪ Noanthropic.claude-3-5-sonnet-20241022-v2:0
OllamaOLLAMA_BASE_URL⚪ Nollama3.2
Hugging FaceHUGGINGFACEHUB_API_TOKEN⚪ Nometa-llama/Llama-3.2-3B-Instruct
**Model Override Variables** (optional): - `ANTHROPIC_MODEL_NAME`, `OPENAI_MODEL_NAME`, `AZURE_OPENAI_MODEL_NAME`, `GOOGLE_GENAI_MODEL_NAME`, `GROQ_MODEL_NAME`, etc.