Skip to content

Conversation

@edenreich
Copy link
Contributor

Summary

This PR improves the AGENTS.md template to fix inaccuracies and enhance readability:

  • Removed irrelevant curl examples - The template previously showed fictional skill execution endpoints that don't exist in the A2A protocol
  • Fixed API endpoints - Now correctly shows only POST /a2a for JSON-RPC instead of individual skill endpoints
  • Corrected environment variables - Updated to use ADK's actual AGENT_CLIENT_* format instead of provider-specific API keys
  • Port consistency - Now uses the configured port from the ADL spec throughout the document
  • Improved formatting - Aligned all comments in the project structure tree and removed excessive blank lines

Changes

Before

# Execute create_dashboard skill
curl -X POST http://localhost:8080/skills/create_dashboard \
  -H "Content-Type: application/json" \
  -d '{"input": "your_input_here"}'

Environment variables:

- `DEEPSEEK_API_KEY` - API key for deepseek
- `PORT` - Server port (default: 8080)

After

Refer to the main README.md for specific skill execution examples and input schemas.

Environment variables:

- `AGENT_CLIENT_PROVIDER` - LLM provider (deepseek)
- `AGENT_CLIENT_MODEL` - Model name (deepseek-chat)
- `AGENT_CLIENT_API_KEY` - API key for your LLM provider
- `PORT` - Server port (configured: 8443)

Test plan

  • Generated a test project with --ai flag
  • Verified AGENTS.md has correct API endpoints
  • Verified environment variables match ADK documentation
  • Verified all comments in project structure are aligned
  • Verified port numbers are consistent throughout

🤖 Generated with Claude Code

- Remove irrelevant curl examples for individual skill execution
- Fix API endpoints to show only POST /a2a JSON-RPC endpoint
- Update environment variables to use ADK's actual AGENT_CLIENT_* format
- Use configured port from ADL spec instead of hardcoded defaults
- Align all comments in project structure tree for better readability
- Remove excessive blank lines throughout the document

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@edenreich edenreich merged commit 7ad0bfa into main Nov 14, 2025
1 check passed
@edenreich edenreich deleted the fix/improve-agents-md-template branch November 14, 2025 14:01
ig-semantic-release-bot bot added a commit that referenced this pull request Nov 14, 2025
## [0.24.1](v0.24.0...v0.24.1) (2025-11-14)

### 🐛 Bug Fixes

* **templates:** improve AGENTS.md template formatting and accuracy ([#90](#90)) ([7ad0bfa](7ad0bfa))
@ig-semantic-release-bot
Copy link
Contributor

🎉 This PR is included in version 0.24.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants