docs: add AGENTS.md and CLAUDE.md for AI coding agent guidance#43
Merged
docs: add AGENTS.md and CLAUDE.md for AI coding agent guidance#43
Conversation
adiadd
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive AI coding agent documentation to help AI assistants understand the project structure and conventions when working with the codebase.
Changes:
- Added
AGENTS.mdwith detailed guidance for AI coding agents including build commands, code style guidelines, architecture overview, and common pitfalls - Added
CLAUDE.mdwith streamlined guidance specifically for Claude Code, focusing on essential commands and architecture patterns
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | Comprehensive documentation for AI coding agents with detailed code style guidelines, architecture, decorators, and development workflows |
| CLAUDE.md | Streamlined reference guide for Claude Code with essential commands, architecture summary, and key patterns |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AGENTS.md
Outdated
| uv run python -m cw_mcp_server.server # Alternative | ||
|
|
||
| # Via uvx (recommended for users) | ||
| ```bash |
There was a problem hiding this comment.
The opening code fence on line 23 is incorrectly placed inside the code block that started on line 13. This line should not have the triple backticks and "bash" keyword. Remove line 23 entirely so that the uvx command is part of the same continuous code block that begins on line 13.
Suggested change
| ```bash |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue number:
N/A
Summary
Changes
Add AI coding agent documentation files:
AGENTS.md: Comprehensive guidance for AI coding agents (Copilot, Cursor, etc.) including buildcommands, code style guidelines, architecture overview, key decorators, and common pitfalls
CLAUDE.md: Streamlined guidance for Claude Code with essential commands, architecture summary, and keypatterns
User experience
Before: AI coding assistants had no project-specific context and would need to infer patterns from
reading source files.
After: AI assistants can immediately understand project structure, required commands (
uv sync,pre-commit run --all-files), coding conventions (Apache-2.0 headers, JSON returns, @handle_exceptions decorator),and AWS client patterns.
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number: N/A
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.