docs: add agent contribution template

[omribz156]

Description

Adds AGENTS_TEMPLATE.md as a copyable scaffold for community-contributed agents, and links it from the README contribution guidelines.

Fixes #55

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

Verification:

npx prettier --check AGENTS_TEMPLATE.md README.md
git diff --check

No runtime tests were run because this is a documentation/template-only change.

This was prepared with Codex assistance, with the final docs reviewed manually and scoped to the requested template.

Summary by CodeRabbit

• Documentation
  • Added a standardized template for documenting new agents, including required metadata, input/output schemas, execution and verification guidance, and reviewer notes.
  • Updated contributing guidelines to require using the new agent documentation template when adding agents.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 793a7bed-a70b-45ff-8784-9d7c0ac1586e

📥 Commits

Reviewing files that changed from the base of the PR and between 9f20955 and cd651f4.

📒 Files selected for processing (1)

• AGENTS_TEMPLATE.md

---

📝 Walkthrough

Walkthrough

This PR adds a standardized template for community contributors to document new agents. AGENTS_TEMPLATE.md defines required sections—metadata, input/output schemas, execution instructions, Claude payload format, mock mode behavior, and verification checklist—while README.md is updated to direct contributors to use this template when documenting new agents.

Changes

Agent Contribution Template

Layer / File(s)	Summary
Agent template and contribution guidelines AGENTS_TEMPLATE.md, README.md	Introduces AGENTS_TEMPLATE.md with scaffolding for agent metadata, inputs/outputs schema, run commands, Claude payload wiring, mock mode expectations, and verification steps. README contributing section updated to direct new agent documentation to use this template.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A template for agents, clean and bright,
So contributors scaffold just right,
Fill fields, wire payloads, run the test,
Mock mode keeps CI calm and blessed,
Hopping commits, the docs take flight! 🐰✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: add agent contribution template' clearly and concisely describes the main change—adding a template file for agents with a documentation focus.
Description check	✅ Passed	The description includes all required sections from the template: summary of changes, related issue fix (#55), type of change (new feature and documentation update), and a thorough checklist with verification steps provided.
Linked Issues check	✅ Passed	The PR successfully implements all required template contents from issue #55: agent metadata (name, status, category, description), input specification, output specification, run instructions, and Claude payload guidance.
Out of Scope Changes check	✅ Passed	All changes are directly in scope: AGENTS_TEMPLATE.md adds the requested template scaffold, and README.md is updated to link to it as specified in issue #55. No unrelated changes detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

AGENTS_TEMPLATE.md (1)

10-10: ⚡ Quick win

Clarify command naming pattern variability.

The template shows npm run run:<agent-name>, but the existing CLI agents use inconsistent patterns (e.g., npm run heal vs. npm run run:auto-pom). Consider adding a note that the exact command format may vary, or standardize on one pattern project-wide.

📝 Suggested clarification

-**Command:** `npm run run:<agent-name>`
+**Command:** `npm run <agent-name>` or `npm run run:<agent-name>` (check `package.json` scripts)

Or add a note below the metadata block explaining the variation.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@AGENTS_TEMPLATE.md` at line 10, The template's example command `npm run
run:<agent-name>` is misleading because CLI agents use different naming patterns
(e.g., `npm run heal` and `npm run run:auto-pom`); update AGENTS_TEMPLATE.md to
either standardize the pattern project-wide or add a concise note below the
metadata block clarifying that the exact `npm run` command may vary per agent
and show both styles (`npm run <name>` and `npm run run:<name>`) as acceptable
examples so readers know the variation.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS_TEMPLATE.md`:
- Around line 47-62: AGENTS_TEMPLATE.md currently shows an outdated payload with
fields {name, description, command, inputs}, but the “Add to Claude” button (see
AgentCard.tsx and SkillCard.tsx) copies a payload shaped as {name, description,
system_prompt, tool_schema: {input_schema: ...}, run_command}; update the
example JSON in AGENTS_TEMPLATE.md to use run_command instead of command,
include a system_prompt string, and replace the simple inputs object with a
tool_schema.input_schema that follows JSON Schema structure (e.g., properties
and required) so the template matches the actual payload produced by
AgentCard/SkillCard.

---

Nitpick comments:
In `@AGENTS_TEMPLATE.md`:
- Line 10: The template's example command `npm run run:<agent-name>` is
misleading because CLI agents use different naming patterns (e.g., `npm run
heal` and `npm run run:auto-pom`); update AGENTS_TEMPLATE.md to either
standardize the pattern project-wide or add a concise note below the metadata
block clarifying that the exact `npm run` command may vary per agent and show
both styles (`npm run <name>` and `npm run run:<name>`) as acceptable examples
so readers know the variation.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c7a7142d-9aee-44a9-a7f3-a8a8338665d5

📥 Commits

Reviewing files that changed from the base of the PR and between d91bcdd and 9f20955.

📒 Files selected for processing (2)

• AGENTS_TEMPLATE.md
• README.md

[omribz156]

Quick check on the red Lint job: it reaches the repo-wide npm run format:check step and reports existing formatting drift in server/index.ts.

This PR only touches AGENTS_TEMPLATE.md and README.md; the focused check I ran before opening was:

npx prettier --check AGENTS_TEMPLATE.md README.md
git diff --check

Both passed. The other GitHub checks for this PR are green, including Docs, UI Build, Typecheck, E2E, and CodeRabbit.

[omribz156]

Thanks, fixed both template issues in cd651f4:

• the command field now notes both script patterns and points contributors at package.json
• the Claude payload now matches AgentCard / SkillCard: system_prompt, tool_schema.input_schema, and run_command

Verification:

• npx prettier --check AGENTS_TEMPLATE.md README.md
• git diff --check

This follow-up was Codex-assisted and manually checked before pushing.