Skip to content

docs: add AGENTS.md for AI coding agents#51

Open
jsonmp-k8 wants to merge 1 commit intokagent-dev:mainfrom
jsonmp-k8:add-agents-md
Open

docs: add AGENTS.md for AI coding agents#51
jsonmp-k8 wants to merge 1 commit intokagent-dev:mainfrom
jsonmp-k8:add-agents-md

Conversation

@jsonmp-k8
Copy link
Contributor

Summary

  • Adds AGENTS.md — a comprehensive guide for AI coding agents working in this repository
  • Covers project architecture, tool provider patterns, build/test commands, and code conventions
  • Includes sections on code reuse (use internal/ packages, don't duplicate across providers) and naming conventions (descriptive names, no abbreviations)
  • Documents the tool registration pattern, CommandBuilder usage, error handling via ToolError, security validation, and caching strategy
  • Provides a step-by-step guide for adding new tool providers

Test plan

  • Verify AGENTS.md renders correctly on GitHub

Add comprehensive guide covering project architecture, tool provider
patterns, build/test commands, code conventions, naming standards,
code reuse guidelines, testing approach, and CI/CD pipeline details.

Signed-off-by: Jaison Paul <paul.jaison@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant