Skip to content

Conversation

@tlongwell-block
Copy link
Collaborator

Summary

Adds an AGENTS.md file following the emerging industry standard for guiding AI coding assistants in repository navigation and development workflows.

Context

AGENTS.md is becoming the standard way to provide repository-specific context to AI coding assistants. It's already adopted by 20k+ open source projects including Apache Airflow, Temporal SDK, and LangGraph. The format serves as a "README for agents" - a predictable location where AI tools can find project-specific commands, structure, and constraints. Goose already reads AGENTS.md by default along with .goosehints.

See: https://agents.md/ for the standard specification.

Why This Matters

As an AI agent framework, Goose should naturally support AI-assisted development of itself. This enables:

  • Faster onboarding for contributors using AI assistants
  • Consistent development practices across AI-human collaboration
  • Reduced errors from AI assistants unfamiliar with our specific workflows
  • Meta-validation: Goose development using Goose

Implementation Quality

Our AGENTS.md is exceptionally concise at 89 lines while remaining comprehensive. Every command is verified against actual source code, every path confirmed to exist. It follows the "reference card, not documentation" philosophy - pure actionable content with zero prose explanation.

Key features:

  • Complete crate structure with binary names noted
  • Exact test invocation patterns
  • Critical "never" rules preventing state corruption
  • Development loop matching our actual CI requirements

This should serve as a model AGENTS.md implementation.

@tlongwell-block tlongwell-block marked this pull request as ready for review September 5, 2025 18:58
Copy link
Contributor

@Kvadratni Kvadratni left a comment

Choose a reason for hiding this comment

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

should be there

@tlongwell-block tlongwell-block merged commit e54ba78 into main Sep 5, 2025
11 checks passed
@tlongwell-block tlongwell-block deleted the agents_md branch September 5, 2025 23:29
michaelneale added a commit that referenced this pull request Sep 8, 2025
* main:
  docs: social channels (#4552)
  feat: simplify navigation, make reload work (#4498)
  docs: new recipe warning (#4545)
  Add AGENTS.md for AI coding assistant support (#4539)
  docs: non-interactive compact now (#4543)
  fixed css classes and added some accessibility fixes (#4492)
  feat(acp): Read files (#4531)
  Add YouTube Short to Auto Visualiser Tutorial (#4536)
  Fix/settings page (#4520)
  update to RMCP 0.6.2 (#4523)
katzdave added a commit that referenced this pull request Sep 8, 2025
…data

* 'main' of github.com:block/goose:
  docs: add ampersand to link (#4560)
  Add video link to README for user guidance (#4553)
  docs: social channels (#4552)
  feat: simplify navigation, make reload work (#4498)
  docs: new recipe warning (#4545)
  Add AGENTS.md for AI coding assistant support (#4539)
  docs: non-interactive compact now (#4543)
  fixed css classes and added some accessibility fixes (#4492)
katzdave added a commit that referenced this pull request Sep 8, 2025
* 'main' of github.com:block/goose:
  docs: add ampersand to link (#4560)
  Add video link to README for user guidance (#4553)
  docs: social channels (#4552)
  feat: simplify navigation, make reload work (#4498)
  docs: new recipe warning (#4545)
  Add AGENTS.md for AI coding assistant support (#4539)
  docs: non-interactive compact now (#4543)
  fixed css classes and added some accessibility fixes (#4492)
  feat(acp): Read files (#4531)
  Add YouTube Short to Auto Visualiser Tutorial (#4536)
  Fix/settings page (#4520)
  update to RMCP 0.6.2 (#4523)
  docs: nested goosehints (#4528)
  feat: Agent Client Protocol implementation of goose (#4511)
  feat: make tests for rmcp based developer server consistent with former implementation (#4519)
  worlds simplest logging to see where things are blocked (#3888)
  docs: update quickstart and install topics (#4378)
  feat: Add configurable Bedrock retry parameters (#4316)
  remove localstorage getconfig fallbacks (#4432)
  chore(deps-dev): bump electron from 37.2.6 to 37.4.0 in /ui/desktop (#4516)
tiensi added a commit to tiensi/goose that referenced this pull request Sep 8, 2025
* main: (43 commits)
  feat: add auto-compact threshold configuration UI (block#4178)
  Add container detection to developer extension (block#4559)
  docs: add ampersand to link (block#4560)
  Add video link to README for user guidance (block#4553)
  docs: social channels (block#4552)
  feat: simplify navigation, make reload work (block#4498)
  docs: new recipe warning (block#4545)
  Add AGENTS.md for AI coding assistant support (block#4539)
  docs: non-interactive compact now (block#4543)
  fixed css classes and added some accessibility fixes (block#4492)
  feat(acp): Read files (block#4531)
  Add YouTube Short to Auto Visualiser Tutorial (block#4536)
  Fix/settings page (block#4520)
  update to RMCP 0.6.2 (block#4523)
  docs: nested goosehints (block#4528)
  feat: Agent Client Protocol implementation of goose (block#4511)
  feat: make tests for rmcp based developer server consistent with former implementation (block#4519)
  worlds simplest logging to see where things are blocked (block#3888)
  docs: update quickstart and install topics (block#4378)
  feat: Add configurable Bedrock retry parameters (block#4316)
  ...
This was referenced Sep 9, 2025
thebristolsound pushed a commit to thebristolsound/goose that referenced this pull request Sep 11, 2025
Signed-off-by: Matt Donovan <mattddonovan@protonmail.com>
HikaruEgashira pushed a commit to HikaruEgashira/goose that referenced this pull request Oct 3, 2025
Signed-off-by: HikaruEgashira <hikaru-egashira@c-fo.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.

3 participants