[sdy0243853-collab]

Add template for creating a custom agent in the repository

📋 Description

🔗 Related Issue

Closes #(issue_number)

🧪 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
• 🔧 Refactoring (no functional changes)
• ⚡ Performance improvement
• 🧹 Code cleanup
• 🔒 Security fix

🧪 Testing

• Manual testing completed
• Functionality verified in development environment
• No breaking changes introduced
• Tested with different connection types (if applicable)

📸 Screenshots (if applicable)

✅ Checklist

• My code follows the project's style guidelines
• I have performed a self-review of my 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 manually tested my changes thoroughly
• I have verified the changes work with different scenarios
• Any dependent changes have been merged and published

📝 Additional Notes

Summary by Sourcery

Add a customizable template for creating repository-specific agents.

New Features:

• Add a starter custom-agent template for repositories under .github/agents.

Documentation:

• Document the basic metadata and prompt structure needed to define a custom agent.

[sourcery-ai]

Reviewer's Guide

Configuration

Add a starter custom-agent definition with metadata fields and placeholder instructions for repository authors to complete.

• .github/agents/my-agent.agent.md L1-13

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've found 1 issue

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path=".github/agents/my-agent.agent.md" line_range="7-8" />
<code_context>
+# To make this agent available, merge this file into the default repository branch.
+# For format details, see: https://gh.io/customagents/config
+
+name:
+description:
+---
+
</code_context>
<issue_to_address>
**Starter agent cannot load**

When the file is merged unchanged and Copilot loads the repository's agents, copilot parses the blank `name` and `description` as null or empty, so the custom-agent loader rejects the profile and users cannot use the starter agent.

Give the agent non-empty `name` and `description` values before checking it in under `.github/agents`.
</issue_to_address>

Sourcery assessment

Approval pending. 1 finding to address first.

Blocking findings: .github/agents/my-agent.agent.md:8

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

[sdy0243853-collab]

In .github/agents/my-agent.agent.md at lines 7-8:

Starter agent cannot load

When the file is merged unchanged and Copilot loads the repository's agents, copilot parses the blank name and description as null or empty, so the custom-agent loader rejects the profile and users cannot use the starter agent.

Give the agent non-empty name and description values before checking it in under .github/agents.

[sdy0243853-collab]

خ

[sdy0243853-collab]

ت

[sdy0243853-collab]

T

[sdy0243853-collab]

ef0062d