Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 28 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This repository stores all system agent templates for Harness agents.
## 📋 Table of Contents

- [Overview](#overview)
- [Available Templates](#available-templates)
- [Template Structure](#template-structure)
- [Adding a New Template](#adding-a-new-template)
- [Template Registration](#template-registration)
Expand All @@ -26,6 +27,23 @@ The Agents service automatically discovers and registers templates from this rep

---

## Available Templates

The following agent templates are currently available in this repository:

| Template Name | Description | Version |
|---------------|-------------|---------|
| **autofix** | Automatically identifies and fixes bugs, errors, and issues in codebases | 1.0.0 |
| **code_coverage** | AI-powered agent that automatically analyzes codebases and generates comprehensive unit tests to increase coverage | 1.0.0 |
| **codereview** | Automated code review agent that analyzes pull requests and provides feedback | 1.0.0 |
| **ffcleanup** | Feature flag cleanup agent that identifies and removes unused feature flags | 1.0.0 |
| **manifest_remediator** | Remediates issues in Kubernetes manifests and deployment configurations | 1.0.0 |
| **onboarding** | Onboarding agent that imports repositories into Harness Code and auto-generates CI pipelines using AI analysis | 1.0.0 |
| **react_upgrade** | AI-powered coding agent that automates React upgrades and code modifications using custom prompts | 1.0.0 |
| **zero_day_remediation** | Automatically identifies and remediates critical vulnerabilities in your software supply chain by proposing fixes and creating pull requests | 1.0.0 |

---

## Template Structure

Each template must be organized in its own directory under `templates/` with the following files:
Expand Down Expand Up @@ -58,10 +76,10 @@ Follow these steps to add a new agent template:

### 1. Create Template Directory

Create a new directory under `templates/` with your agent's name (use lowercase, hyphen-separated names):
Create a new directory under `templates/` with your agent's name (use lowercase, underscore-separated names):

```bash
mkdir -p templates/my-agent
mkdir -p templates/my_agent
```

### 2. Create Required Files
Expand All @@ -72,7 +90,7 @@ Define your template's metadata:

```json
{
"name": "my-agent",
"name": "my_agent",
"description": "Brief description of what this agent does",
"version": "1.0.0"
}
Expand All @@ -92,9 +110,9 @@ pipeline:
repo:
name: <+inputs.repo>
stages:
- name: my-agent-stage
- name: my_agent_stage
steps:
- name: my-agent-step
- name: my_agent_step
run:
container:
image: your-registry/your-image:tag
Expand Down Expand Up @@ -175,8 +193,8 @@ Provide an SVG logo for your agent to enhance visual identification in the UI:
### 3. Commit and Push

```bash
git add templates/my-agent/
git commit -m "Add my-agent template"
git add templates/my_agent/
git commit -m "Add my_agent template"
git push origin main
```

Expand Down Expand Up @@ -226,7 +244,7 @@ Optional enhancements:

```json
{
"name": "string", // Template identifier (lowercase, alphanumeric, hyphens)
"name": "string", // Template identifier (lowercase, alphanumeric, underscores)
"description": "string", // Brief description (1-2 sentences)
"version": "string" // Semantic version (MAJOR.MINOR.PATCH)
}
Expand Down Expand Up @@ -258,8 +276,8 @@ Provides user-facing documentation for the agent template. When present, this is

### Naming Conventions

- ✅ Use Sentence Case: `My Agent`, `Code Coverage`, `Library Upgrade`, `Autofix`, `Manifest Rendering`
- ❌ Avoid: `MyAgent`, `my_agent`, `MYAGENT`, `my-agent`, `code-scanner`
- ✅ Use lowercase with underscores: `code_coverage`, `react_upgrade`, `zero_day_remediation`, `manifest_remediator`
- ❌ Avoid: `MyAgent`, `my-agent`, `MYAGENT`, `Code-Coverage`, `codeScanner`

### Documentation

Expand Down
2 changes: 1 addition & 1 deletion templates/code-coverage/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Code Coverage",
"name": "code_coverage",
"description": "AI-powered agent that automatically analyzes codebases and generates comprehensive unit tests to increase coverage",
"version": "1.0.0"
}
Expand Down
2 changes: 1 addition & 1 deletion templates/codereview/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Code Review",
"name": "code_review",
"description": "Code Review is an agent that can be used to review code changes and comment on pull requests",
"version": "1.0.0"
}
2 changes: 1 addition & 1 deletion templates/ffcleanup/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "feature flag cleanup",
"name": "feature_flag_cleanup",
"description": "Feature Flag Cleanup is an agent that will help you cleaning up stales feature flags from your code",
"version": "1.0.0"
}
2 changes: 1 addition & 1 deletion templates/manifest-remediator/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Manifest Remediator",
"name": "manifest_remediator",
"description": "Analyzes Kubernetes and Helm deployment failures, generates targeted fixes, and produces remediation YAML with actionable solutions",
"version": "1.0.0"
}
2 changes: 1 addition & 1 deletion templates/react-upgrade/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "React Upgrade",
"name": "react_upgrade",
"description": "AI-powered coding agent that automates React upgrades and code modifications using custom prompts",
"version": "1.0.0"
}
Expand Down
2 changes: 1 addition & 1 deletion templates/zero-day-remediation/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Zero Day Remediation",
"name": "zero_day_remediation",
"description": "Zero Day Remediation is an agent that automatically identifies and remediates critical vulnerabilities in your software supply chain by proposing fixes and creating pull requests.",
"version": "1.0.0"
}