Skip to content

Issue: S-1 Title: AGENTS.md - Agent Documentation System Description: # AGENTS.md - Agent Documentation System This file describes the agent system for managing and searching AGENTS.md documentation #489

Open
locnguyen1986 wants to merge 1 commit intomainfrom
feature/main-task-iss_790f6d2d-80c6-47-1772182111

Conversation

@locnguyen1986
Copy link
Collaborator

Task

Issue: S-1
Title: AGENTS.md - Agent Documentation System
Description: # AGENTS.md - Agent Documentation System

This file describes the agent system for managing and searching AGENTS.md documentation files.

Overview

This system provides agents with the capability to maintain, update, and search through AGENTS.md files across a project or codebase.

Agent Capabilities

1. Search AGENTS.md Files

Purpose: Find specific information across all AGENTS.md files

Search Capabilities:

  • Full-text search across all AGENTS.md files
  • Search by keywords, patterns, or specific terms
  • Find agent definitions, capabilities, or documentation

Search Methods:

  • Text-based search
  • Pattern matching
  • Keyword lookup

2. Update AGENTS.md Files

Purpose: Modify and maintain AGENTS.md documentation

Update Capabilities:

  • Add new agent definitions
  • Update existing agent descriptions
  • Add new capabilities or modify existing ones
  • Maintain consistency across documentation

Usage

Searching Documentation

Search across all AGENTS.md files for:
- Specific agent capabilities
- Documentation patterns
- Implementation details

Updating Documentation

Update AGENTS.md files to:
- Add new agent definitions
- Modify existing descriptions
- Reflect changes in agent behavior
- Maintain up-to-date documentation

Agent Structure

Each agent in AGENTS.md should follow this structure:

# Agent Name

## Purpose
Description of the agent's main purpose

## Capabilities
- Capability 1
- Capability 2

## Usage
How to use this agent

Maintenance

  • Regularly review and update AGENTS.md files
  • Ensure all agent changes are reflected in documentation
  • Search before adding new agents to avoid duplicates

Note: This AGENTS.md serves as a template for agent documentation management systems. The actual implementation would require file system access to read, search, and modify AGENTS.md files in your project.

Would you like me to explain more about how to implement this system, or do you have specific requirements for the agent functionality?

Requirement

Implement the changes described in issue S-1: AGENTS.md - Agent Documentation System

Details:

AGENTS.md - Agent Documentation System

This file describes the agent system for managing and searching AGENTS.md documentation files.

Overview

This system provides agents with the capability to maintain, update, and search through AGENTS.md files across a project or codebase.

Agent Capabilities

1. Search AGENTS.md Files

Purpose: Find specific information across all AGENTS.md files

Search Capabilities:

  • Full-text search across all AGENTS.md files
  • Search by keywords, patterns, or specific terms
  • Find agent definitions, capabilities, or documentation

Search Methods:

  • Text-based search
  • Pattern matching
  • Keyword lookup

2. Update AGENTS.md Files

Purpose: Modify and maintain AGENTS.md documentation

Update Capabilities:

  • Add new agent definitions
  • Update existing agent descriptions
  • Add new capabilities or modify existing ones
  • Maintain consistency across documentation

Usage

Searching Documentation

Search across all AGENTS.md files for:
- Specific agent capabilities
- Documentation patterns
- Implementation details

Updating Documentation

Update AGENTS.md files to:
- Add new agent definitions
- Modify existing descriptions
- Reflect changes in agent behavior
- Maintain up-to-date documentation

Agent Structure

Each agent in AGENTS.md should follow this structure:

# Agent Name

## Purpose
Description of the agent's main purpose

## Capabilities
- Capability 1
- Capability 2

## Usage
How to use this agent

Maintenance

  • Regularly review and update AGENTS.md files
  • Ensure all agent changes are reflected in documentation
  • Search before adding new agents to avoid duplicates

Note: This AGENTS.md serves as a template for agent documentation management systems. The actual implementation would require file system access to read, search, and modify AGENTS.md files in your project.

Would you like me to explain more about how to implement this system, or do you have specific requirements for the agent functionality?

Summary

Added a new Agent Documentation System section to the existing AGENTS.md file at the repository root. The new section provides AI agents with guidelines for managing and searching AGENTS.md documentation files, including search capabilities (full-text, pattern matching, keyword lookup), update capabilities (add/modify agent definitions), usage examples, and a standard agent structure template. This enables agents to maintain consistent documentation across the codebase.

Files Changed

  • AGENTS.md

Automated by Tokamak Agent Service

Added new section describing the agent system for managing and searching
AGENTS.md documentation files, including search capabilities, update
capabilities, usage guidelines, and maintenance recommendations.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings February 27, 2026 08:49
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation to the repository’s root AGENTS.md describing an “Agent Documentation System” for searching and maintaining AGENTS.md files across a codebase.

Changes:

  • Introduces a new “Agent Documentation System” section with search and update capabilities.
  • Adds usage guidance for searching/updating AGENTS.md documentation.
  • Provides a standard template for documenting individual agents.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants