Skip to content

docs: add AGENTS.md for AI contributors - #709

Open
wustwyh wants to merge 1 commit into
lastmile-ai:mainfrom
wustwyh:docs/add-agents-md
Open

docs: add AGENTS.md for AI contributors#709
wustwyh wants to merge 1 commit into
lastmile-ai:mainfrom
wustwyh:docs/add-agents-md

Conversation

@wustwyh

@wustwyh wustwyh commented Jun 26, 2026

Copy link
Copy Markdown

Summary

Adds an AGENTS.md file to help AI coding agents quickly understand the mcp-agent project layout, development commands (make sync, make lint, make tests, etc.), contribution workflow, and agent-specific tips.

The repository has a detailed CONTRIBUTING.md and README.md, but no concise onboarding file for automated agents. AGENTS.md extracts the essential commands and conventions so agents can make focused, well-tested contributions.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation only
  • Refactor / internal cleanup

Test Plan

  • Verified the Markdown renders correctly.
  • Confirmed all referenced Makefile targets exist in the repository.
  • No code changes, so no functional tests required.

Related Issues

None.

Notes for Reviewers

This is a documentation-only addition.

Summary by CodeRabbit

  • Documentation
    • Added contributor guidance with project overview, setup requirements, common development commands, testing steps, and contribution workflow tips.
    • Included practical notes to help keep changes focused and maintain consistency when contributing.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a7053f98-8c49-41cd-8931-e859a04ad68f

📥 Commits

Reviewing files that changed from the base of the PR and between f62d849 and 6197de9.

📒 Files selected for processing (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

Adds a new AGENTS.md contributor guide for mcp-agent, covering project layout, setup prerequisites, common commands, testing steps, workflow, and PR hygiene tips.

Changes

AGENTS.md contributor guide

Layer / File(s) Summary
Overview and commands
AGENTS.md
Adds the project overview, repository map, prerequisites, common development commands, pre-commit guidance, and basic example testing steps.
Workflow and hygiene
AGENTS.md
Adds secret-file guidance, contribution workflow steps, and contributor tips for focused changes, tests/examples, and public API updates.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • lastmile-ai/mcp-agent#506: Adds related setup and contributor guidance for mcp-agent, including project initialization instructions in the docs.

Suggested reviewers

  • saqadri
  • StreetLamb

Poem

I hopped through AGENTS.md by moonlit light,
A burrow of commands, neat and bright.
Sync, lint, and tests now guide my way,
With carrots of clues for every play.
Hoppy docs, and off we go! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the documentation-only addition of AGENTS.md for AI contributors.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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