Standardize agent headers #563
Open
+218
−174
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes agent metadata headers across all agent definition files to ensure consistent display in VS Code and other tooling.
Changes:
- Standardized the order of frontmatter fields (name first, then description)
- Converted all name and description values to use double quotes instead of single quotes
- Applied Title Case formatting to agent names
- Applied Sentence case formatting to descriptions
Reviewed changes
Copilot reviewed 135 out of 135 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| agents/wg-code-sentinel.agent.md | Added missing name field with Title Case formatting, updated description to double quotes |
| agents/wg-code-alchemist.agent.md | Added missing name field with Title Case formatting, updated description to double quotes |
| agents/voidbeast-gpt41enhanced.agent.md | Added name field, standardized quote usage |
| agents/typescript-mcp-expert.agent.md | Reordered fields to place name before description |
| agents/terraform.agent.md | Updated name field to use double quotes |
| agents/terraform-iac-reviewer.agent.md | Updated name and description to use double quotes instead of single quotes |
| agents/terraform-azure-planning.agent.md | Reordered fields to place name before description |
| agents/terraform-azure-implement.agent.md | Reordered fields to place name before description |
| agents/technical-content-evaluator.agent.md | Standardized name format to Title Case and updated to double quotes |
| agents/tech-debt-remediation-plan.agent.md | Added missing name field, updated description to double quotes |
| agents/tdd-refactor.agent.md | Reordered fields to place name before description |
| agents/tdd-red.agent.md | Reordered fields to place name before description |
| agents/tdd-green.agent.md | Reordered fields, updated quote style to double quotes |
| agents/task-researcher.agent.md | Reordered fields to place name before description |
| agents/task-planner.agent.md | Reordered fields to place name before description |
| agents/swift-mcp-expert.agent.md | Reordered fields to place name before description |
| agents/stackhawk-security-onboarding.agent.md | Standardized name to Title Case and updated to double quotes |
| agents/specification.agent.md | Added missing name field, updated description to double quotes |
| agents/software-engineer-agent-v1.agent.md | Added missing name field, updated description to double quotes |
| agents/simple-app-idea-generator.agent.md | Added missing name field, updated description to double quotes |
| agents/shopify-expert.agent.md | Added missing name field, updated description to double quotes |
| agents/semantic-kernel-python.agent.md | Added missing name field, updated description to double quotes |
| agents/semantic-kernel-dotnet.agent.md | Added missing name field, updated description to double quotes |
| agents/search-ai-optimization-expert.agent.md | Added missing name field, updated description to double quotes |
| agents/se-ux-ui-designer.agent.md | Updated name and description to use double quotes |
| agents/se-technical-writer.agent.md | Updated name and description to use double quotes |
| agents/se-system-architecture-reviewer.agent.md | Updated name and description to use double quotes |
| agents/se-security-reviewer.agent.md | Updated name and description to use double quotes |
| agents/se-responsible-ai-code.agent.md | Updated name and description to use double quotes |
| agents/se-product-manager-advisor.agent.md | Updated name and description to use double quotes |
| agents/se-gitops-ci-specialist.agent.md | Updated name and description to use double quotes |
| agents/salesforce-expert.agent.md | Reordered fields to place name before description |
| agents/rust-mcp-expert.agent.md | Reordered fields to place name before description |
| agents/rust-gpt-4.1-beast-mode.agent.md | Reordered fields, removed empty line in frontmatter, updated to double quotes |
| agents/ruby-mcp-expert.agent.md | Reordered fields to place name before description |
| agents/research-technical-spike.agent.md | Reordered fields, standardized name to Title Case |
| agents/refine-issue.agent.md | Added missing name field, updated description to double quotes |
| agents/python-mcp-expert.agent.md | Reordered fields to place name before description |
| agents/prompt-engineer.agent.md | Added missing name field |
| agents/prompt-builder.agent.md | Added missing name field, updated description to double quotes |
| agents/principal-software-engineer.agent.md | Added missing name field, updated description to double quotes |
| agents/prd.agent.md | Reordered fields to place name before description |
| agents/power-platform-mcp-integration-expert.agent.md | Reordered fields to place name before description |
| agents/power-platform-expert.agent.md | Reordered fields to place name before description |
| agents/power-bi-visualization-expert.agent.md | Reordered fields to place name before description |
| agents/power-bi-performance-expert.agent.md | Reordered fields to place name before description |
| agents/power-bi-dax-expert.agent.md | Reordered fields to place name before description |
| agents/power-bi-data-modeling-expert.agent.md | Reordered fields to place name before description |
| agents/postgresql-dba.agent.md | Reordered fields to place name before description |
| agents/playwright-tester.agent.md | Reordered fields to place name before description |
| agents/platform-sre-kubernetes.agent.md | Standardized name to Title Case and updated to double quotes |
| agents/planner.agent.md | Reordered fields, standardized name to Title Case |
| agents/plan.agent.md | Reordered fields, removed hyphens from name |
| agents/pimcore-expert.agent.md | Added missing name field, updated description to double quotes |
| agents/php-mcp-expert.agent.md | Reordered fields to place name before description |
| agents/pagerduty-incident-responder.agent.md | Updated name and description to use double quotes |
| agents/octopus-deploy-release-notes-mcp.agent.md | Standardized name to Title Case and updated to double quotes |
| agents/neon-optimization-analyzer.agent.md | Updated name and description to use double quotes |
| agents/neon-migration-specialist.agent.md | Updated name and description to use double quotes |
| agents/neo4j-docker-client-generator.agent.md | Standardized name to Title Case and updated to double quotes |
| agents/ms-sql-dba.agent.md | Reordered fields, standardized name format |
| agents/mongodb-performance-advisor.agent.md | Standardized name to Title Case and updated to double quotes |
| agents/monday-bug-fixer.agent.md | Updated name and description to use double quotes |
| agents/modernization.agent.md | Added missing name field, updated description to double quotes |
| agents/microsoft_learn_contributor.agent.md | Added missing name field, updated description to double quotes |
| agents/microsoft-study-mode.agent.md | Added missing name field, updated description to double quotes |
| agents/microsoft-agent-framework-python.agent.md | Added missing name field |
| agents/microsoft-agent-framework-dotnet.agent.md | Added missing name field |
| agents/meta-agentic-project-scaffold.agent.md | Reordered fields to place name before description |
| agents/mentor.agent.md | Added missing name field, updated description to double quotes |
| agents/mcp-m365-agent-expert.agent.md | Reordered fields to place name before description |
| agents/lingodotdev-i18n.agent.md | Updated name and description to use double quotes |
| agents/launchdarkly-flag-cleanup.agent.md | Standardized name to Title Case and updated description quote style |
| agents/laravel-expert-agent.agent.md | Added missing name field, updated description to double quotes |
| agents/kusto-assistant.agent.md | Added missing name field |
| agents/kotlin-mcp-expert.agent.md | Reordered fields to place name before description and model after description |
| agents/jfrog-sec.agent.md | Updated name and description to use double quotes |
| agents/java-mcp-expert.agent.md | Reordered fields to place name before description |
| agents/janitor.agent.md | Added missing name field, updated description to double quotes |
| agents/implementation-plan.agent.md | Reordered fields to place name before description |
| agents/hlbpa.agent.md | Added missing name field, updated description to double quotes |
| agents/gpt-5-beast-mode.agent.md | Reordered fields, removed redundant name field, updated to double quotes |
| agents/go-mcp-expert.agent.md | Reordered fields to place name before description and model after description |
| agents/github-actions-expert.agent.md | Updated name and description to use double quotes |
| agents/gilfoyle.agent.md | Added missing name field, updated description to double quotes |
| agents/expert-react-frontend-engineer.agent.md | Reordered fields to place name before description |
| agents/expert-nextjs-developer.agent.md | Added missing name field |
| agents/expert-dotnet-software-engineer.agent.md | Reordered fields, standardized name to Title Case |
| agents/expert-cpp-software-engineer.agent.md | Added missing name field, updated description to double quotes |
| agents/electron-angular-native.agent.md | Reordered fields to place name before description |
| agents/elasticsearch-observability.agent.md | Standardized name to Title Case and updated to double quotes |
| agents/dynatrace-expert.agent.md | Updated name and description to use double quotes |
| agents/drupal-expert.agent.md | Added missing name field, updated description to double quotes |
| agents/droid.agent.md | Updated name and description to use double quotes |
| agents/dotnet-upgrade.agent.md | Added missing name field, updated description to double quotes |
| agents/dotnet-maui.agent.md | Updated name and description to use double quotes |
| agents/diffblue-cover.agent.md | Updated name and description to use double quotes |
| agents/devops-expert.agent.md | Updated name and description to use double quotes |
| agents/demonstrate-understanding.agent.md | Added missing name field, updated description to double quotes |
| agents/declarative-agents-architect.agent.md | Added missing name and description fields |
| agents/debug.agent.md | Added missing name field, updated description to double quotes |
| agents/custom-agent-foundry.agent.md | Reordered fields, updated description to double quotes |
| agents/csharp-mcp-expert.agent.md | Reordered fields to place name before description |
| agents/csharp-dotnet-janitor.agent.md | Added missing name field, updated description to double quotes |
| agents/critical-thinking.agent.md | Added missing name field, updated description to double quotes |
| agents/context7.agent.md | Standardized name to Title Case and updated to double quotes |
| agents/comet-opik.agent.md | Updated name and description to use double quotes |
| agents/code-tour.agent.md | Reordered fields, updated description to double quotes |
| agents/clojure-interactive-programming.agent.md | Reordered fields to place name before description |
| agents/blueprint-mode.agent.md | Reordered fields, updated name to Title Case and to double quotes |
| agents/blueprint-mode-codex.agent.md | Reordered fields, updated name to Title Case and to double quotes |
| agents/bicep-plan.agent.md | Added missing name field, updated description to double quotes |
| agents/bicep-implement.agent.md | Added missing name field, updated description to double quotes |
| agents/azure-verified-modules-terraform.agent.md | Reordered fields, standardized name to Title Case |
| agents/azure-verified-modules-bicep.agent.md | Reordered fields, standardized name to Title Case |
| agents/azure-saas-architect.agent.md | Reordered fields, standardized name to Title Case |
| agents/azure-principal-architect.agent.md | Reordered fields, standardized name to Title Case |
| agents/azure-logic-apps-expert.agent.md | Reordered fields to place name before description |
| agents/azure-iac-generator.agent.md | Updated name to Title Case and to double quotes |
| agents/azure-iac-exporter.agent.md | Updated name to Title Case and to double quotes |
| agents/atlassian-requirements-to-jira.agent.md | Added missing name field, updated description to double quotes |
| agents/arm-migration.agent.md | Updated name to Title Case and to double quotes |
| agents/arch.agent.md | Removed empty line, updated to double quotes |
| agents/apify-integration-expert.agent.md | Updated name to Title Case and to double quotes |
| agents/api-architect.agent.md | Added missing name field, updated description to double quotes |
| agents/amplitude-experiment-implementation.agent.md | Updated name and description to use double quotes |
| agents/aem-frontend-specialist.agent.md | Added missing name field, updated description to double quotes |
| agents/adr-generator.agent.md | Updated name and description to use double quotes |
| agents/address-comments.agent.md | Added missing name field |
| agents/accessibility.agent.md | Added missing name field, updated description to double quotes |
| agents/WinFormsExpert.agent.md | Updated name and description to use double quotes |
| agents/Ultimate-Transparent-Thinking-Beast-Mode.agent.md | Updated name and description to use double quotes |
| agents/Thinking-Beast-Mode.agent.md | Reordered fields, updated to double quotes |
| agents/CSharpExpert.agent.md | Updated description to use double quotes |
| agents/4.1-Beast.agent.md | Reordered fields, updated name to Title Case and to double quotes |
| @@ -1,5 +1,6 @@ | |||
| --- | |||
| description: 'Ask WG Code Sentinel to review your code for security issues.' | |||
| name: "Wg Code Sentinel" | |||
There was a problem hiding this comment.
Agent name should use Title Case format. "Wg" should be "WG" to properly capitalize the acronym.
Suggested change
| name: "Wg Code Sentinel" | |
| name: "WG Code Sentinel" |
| @@ -1,5 +1,6 @@ | |||
| --- | |||
| description: 'Ask WG Code Alchemist to transform your code with Clean Code principles and SOLID design' | |||
| name: "Wg Code Alchemist" | |||
There was a problem hiding this comment.
Agent name should use Title Case format. "Wg" should be "WG" to properly capitalize the acronym.
Suggested change
| name: "Wg Code Alchemist" | |
| name: "WG Code Alchemist" |
| @@ -1,6 +1,6 @@ | |||
| --- | |||
| name: "TDD Refactor Phase Improve Quality & Security" | |||
There was a problem hiding this comment.
Agent name is missing a hyphen. Should be "TDD Refactor Phase - Improve Quality & Security" to match the pattern used in other TDD phase agents.
Suggested change
| name: "TDD Refactor Phase Improve Quality & Security" | |
| name: "TDD Refactor Phase - Improve Quality & Security" |
Comment on lines
+2
to
3
| name: "TDD Red Phase Write Failing Tests First" | ||
| description: "Guide test-first development by writing failing tests that describe desired behaviour from GitHub issue context before implementation exists." |
There was a problem hiding this comment.
Agent name is missing a hyphen. Should be "TDD Red Phase - Write Failing Tests First" to match the pattern used in other TDD phase agents.
Suggested change
| name: "TDD Red Phase Write Failing Tests First" | |
| description: "Guide test-first development by writing failing tests that describe desired behaviour from GitHub issue context before implementation exists." | |
| name: "TDD Red Phase - Write Failing Tests First" | |
| description: 'Guide test-first development by writing failing tests that describe desired behaviour from GitHub issue context before implementation exists.' |
| --- | ||
| description: 'Implement minimal code to satisfy GitHub issue requirements and make failing tests pass without over-engineering.' | ||
| name: 'TDD Green Phase - Make Tests Pass Quickly' | ||
| name: "TDD Green Phase Make Tests Pass Quickly" |
There was a problem hiding this comment.
Agent name is missing a hyphen. Should be "TDD Green Phase - Make Tests Pass Quickly" to match the pattern used in other TDD phase agents.
Suggested change
| name: "TDD Green Phase Make Tests Pass Quickly" | |
| name: "TDD Green Phase - Make Tests Pass Quickly" |
| --- | ||
| name: 'Platform SRE for Kubernetes' | ||
| description: 'SRE-focused Kubernetes specialist prioritizing reliability, safe rollouts/rollbacks, security defaults, and operational verification for production-grade deployments' | ||
| name: "Platform SRE For Kubernetes" |
There was a problem hiding this comment.
Agent name has inconsistent capitalization. "For" should be lowercase: "Platform SRE for Kubernetes" to follow standard Title Case conventions where prepositions are lowercase.
Suggested change
| name: "Platform SRE For Kubernetes" | |
| name: "Platform SRE for Kubernetes" |
| --- | ||
| name: octopus-release-notes-with-mcp | ||
| description: Generate release notes for a release in Octopus Deploy. The tools for this MCP server provide access to the Octopus Deploy APIs. | ||
| name: "Octopus Release Notes With Mcp" |
There was a problem hiding this comment.
Agent name has incorrect capitalization. "Mcp" should be "MCP" to properly capitalize the acronym. Should be "Octopus Release Notes With MCP".
Suggested change
| name: "Octopus Release Notes With Mcp" | |
| name: "Octopus Release Notes With MCP" |
| --- | ||
| name: mongodb-performance-advisor | ||
| description: Analyze MongoDB database performance, offer query and index optimization insights and provide actionable recommendations to improve overall usage of the database. | ||
| name: "Mongodb Performance Advisor" |
There was a problem hiding this comment.
Agent name has incorrect capitalization. "Mongodb" should be "MongoDB" to match the product's proper casing.
Suggested change
| name: "Mongodb Performance Advisor" | |
| name: "MongoDB Performance Advisor" |
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| name: azure-iac-generator | |||
| name: "Azure Iac Generator" | |||
There was a problem hiding this comment.
Agent name has incorrect capitalization. "Iac" should be "IaC" to properly capitalize the acronym "Infrastructure as Code".
Suggested change
| name: "Azure Iac Generator" | |
| name: "Azure IaC Generator" |
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| name: azure-iac-exporter | |||
| name: "Azure Iac Exporter" | |||
There was a problem hiding this comment.
Agent name has incorrect capitalization. "Iac" should be "IaC" to properly capitalize the acronym "Infrastructure as Code".
Suggested change
| name: "Azure Iac Exporter" | |
| name: "Azure IaC Exporter" |
Contributor
|
While I appreciate the intent of this PR, it is a very heavy-handed approach to what is a fairly nuanced problem. As can be seen above, there are a lot of merge conflicts that come up from this, and Copilot has flagged many of the changes as resulting in bad casing or grammar on them. Also, as I was doing my own review, I note there are lots of changes which are superficial, such as re-ordering the fields in the front matter or wrapping quotes - these don't really result in observable improvements but do make the PR review process more time consuming. A better approach would be to focus on the ones that are representing problems within Copilot experiences and updating them so it's easier to review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Agent definitions should follow a standard format at the top of each agent file so that they display consistently in e.g. VSCode
Agent definition starts with Name, followed by Description
Agent name is in Title Case
Agent description is in Sentence case
Name and Description values are both enclosed in double quotes