Skip to content

qodo-ai/agents

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

19 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Qodo Agent Reference Implementations

🚧 PROJECT STATUS: This repository is under active development. Most agents listed are planned features and not yet implemented. Only agents marked with βœ… are currently available. We welcome contributions to help build these agents!

A curated collection of reference agent implementations for the Qodo CLI framework, showcasing best practices and common patterns for building AI-powered development workflows.

What are Qodo Agents?

Qodo Agents are configurable AI workflows that combine:

  • Instructions: Natural language prompts that define the agent's behavior
  • Tools: MCP servers and external integrations the agent can use
  • Arguments: Configurable parameters for customization
  • Execution Strategy: How the agent approaches tasks (plan vs act)
  • Output Schema: Structured output format for integration
  • Exit Expressions: Success/failure conditions for CI/CD

🌟 Reference Agents

These agents demonstrate core patterns and best practices for the Qodo framework.

⚠️ IMPLEMENTATION STATUS: Most of the agents listed below are not yet implemented and are included as planned features. Only agents marked with βœ… are currently available. We are actively working on implementing these agents - contributions are welcome!

Development Workflow Agents

  • Code Review βœ… - Comprehensive code review with Qodo Merge integration
  • Diff Test Generation βœ… - Automated test suite creation and validation of code changes
  • Documentation 🚧 Not yet implemented - Generate and maintain project documentation
  • Refactoring 🚧 Not yet implemented - Safe code refactoring with validation
  • Security Audit 🚧 Not yet implemented - Security vulnerability scanning and remediation

CI/CD Integration Agents

Project Management Agents

  • Issue Triage 🚧 Not yet implemented - Automated issue classification and routing
  • Sprint Planning 🚧 Not yet implemented - Sprint planning assistance
  • Technical Debt 🚧 Not yet implemented - Technical debt identification and prioritization

Data & Analytics Agents

  • Data Pipeline 🚧 Not yet implemented - Data pipeline monitoring and validation
  • Report Generation 🚧 Not yet implemented - Automated report generation
  • Metrics Analysis 🚧 Not yet implemented - Performance metrics analysis

🀝 Community Agents

Community-contributed agents demonstrating various use cases and integrations.

⚠️ IMPLEMENTATION STATUS: The community agents listed below are planned features and are not yet implemented. We encourage community contributions to help build these agents!

Note: Community agents are maintained by their respective authors and should be used at your own discretion.

Language-Specific Agents

  • Python Linting 🚧 Not yet implemented - Python-specific code quality checks
  • JavaScript Testing 🚧 Not yet implemented - JavaScript/TypeScript testing workflows
  • Go Optimization 🚧 Not yet implemented - Go performance optimization
  • Rust Safety 🚧 Not yet implemented - Rust memory safety validation

Framework-Specific Agents

  • React Component 🚧 Not yet implemented - React component analysis and optimization
  • Django Migration 🚧 Not yet implemented - Django database migration validation
  • FastAPI Documentation 🚧 Not yet implemented - FastAPI documentation generation

Integration Agents

  • GitHub Actions 🚧 Not yet implemented - GitHub Actions workflow optimization
  • Docker Security 🚧 Not yet implemented - Docker container security scanning
  • Kubernetes Health 🚧 Not yet implemented - Kubernetes cluster health monitoring

πŸ“š Agent Categories

By Execution Strategy

  • Planning Agents - Multi-step strategic approaches
  • Action Agents - Direct execution patterns

By Integration Type

  • MCP-Based - Leveraging Model Context Protocol servers
  • API-Based - Direct API integrations
  • Tool-Based - Command-line tool integrations

By Output Type

  • Structured Data - JSON/YAML output for automation
  • Reports - Human-readable analysis
  • Actions - Direct system modifications

πŸš€ Getting Started

Prerequisites

  • Qodo CLI installed
  • Node.js 18+ and npm
  • Git for version control

Quick Start

  1. Clone this repository:

    git clone https://github.com/qodo-ai/agent-reference-implementations.git
    cd agent-reference-implementations
  2. Choose an agent:

    # Copy a reference agent to your project
    cp -r src/code-review/ /path/to/your/project/agents/
  3. Configure the agent:

    # Edit the agent configuration
    vim /path/to/your/project/agents/code-review/agent.toml
  4. Run the agent:

    cd /path/to/your/project
    qodo code-review --agent-file=agents/code-review/agent.toml

Using Reference Agents

Each reference agent includes:

  • Configuration file (agent.toml or agent.yaml)
  • README with usage instructions and examples
  • Test cases demonstrating expected behavior
  • Integration examples for common scenarios

πŸ› οΈ Creating Your Own Agent

Basic Agent Structure

# agent.toml
version = "1.0"
[commands.my_agent]
description = "Detailed description for users"
instructions = """
Your agent's behavior instructions here.
Be specific about the task and expected outcomes.
"""

# Optional: Define arguments
arguments = [
    { name = "input_file", type = "string", required = true, description = "Input file path" },
    { name = "threshold", type = "number", required = false, default = 0.8, description = "Quality threshold" }
]

# Optional: MCP servers your agent uses
mcpServers = """
{
    "shell": {
      "command": "uvx",
      "args": [
        "mcp-shell-server"
      ],
      "env": {
        "ALLOW_COMMANDS": "..."
      }
    },
    "github": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "GITHUB_PERSONAL_ACCESS_TOKEN",
        "ghcr.io/github/github-mcp-server"
      ]
    }
}
"""

# Optional: Define available tools
available_tools = ["filesystem", "git", "shell", "github"]

# Optional: Define execution strategy: "plan" for multi-step, "act" for direct execution
execution_strategy = "act"

# Optional: Define expected output structure
output_schema = """
{
    "properties": {
        "success": {"type": "boolean"},
        "results": {"type": "array", "items": {"type": "string"}},
        "score": {"type": "number"}
    }
}
"""

# Optional: Success condition for CI/CD
exit_expression = "success"

Agent Development Guidelines

  1. Clear Instructions: Write specific, actionable instructions
  2. Proper Tool Selection: Choose appropriate MCP servers and tools
  3. Error Handling: Include error scenarios in instructions
  4. Testing: Provide test cases and expected outputs
  5. Documentation: Include comprehensive README and examples

Testing Your Agent

# Test with sample data
qodo my_agent --input_file=test/sample.txt --threshold=0.9

# Validate output schema
qodo my_agent --input_file=test/sample.txt | jq '.success'

# CI/CD integration test
qodo my_agent --ci --input_file=test/sample.txt

πŸ“– Documentation

Agent Configuration Reference

Best Practices

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

How to Contribute

  1. Reference Agents: Submit well-documented, tested agents
  2. Community Agents: Share your specialized use cases
  3. Documentation: Improve guides and examples
  4. Bug Reports: Report issues with existing agents

Contribution Guidelines

  • Follow the Agent Development Guidelines
  • Include comprehensive tests and documentation
  • Ensure compatibility with latest Qodo CLI version
  • Add your agent to the appropriate category in this README

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ”— Related Projects

πŸ’¬ Community

⭐ Support

If you find these agent implementations useful, please consider:

  • Starring this repository
  • Contributing your own agents
  • Sharing feedback and suggestions
  • Helping improve documentation

Built with ❀️ by the Qodo community

About

Qodo CLI Agents

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages