v0.2: Simplify spec + add MCP gateway integration
Major revision based on first principles thinking: - Simplified format: plain Markdown, human readable - Focus on capabilities (Can/Cannot) not API schemas - MCP gateway pointer for structured tool access - Clear positioning vs robots.txt and llms.txt The agents.md file is the handshake. The MCP gateway is where real work happens. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
88
README.md
Normal file
88
README.md
Normal file
@@ -0,0 +1,88 @@
|
||||
# agents.md
|
||||
|
||||
**Tell AI agents what they can do on your website.**
|
||||
|
||||
## The Gap
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| robots.txt | What bots **cannot access** |
|
||||
| llms.txt | What **content matters** |
|
||||
| **agents.md** | What agents **can do** |
|
||||
|
||||
## Quick Start
|
||||
|
||||
Create `/.well-known/agents.md`:
|
||||
|
||||
```markdown
|
||||
# My Site
|
||||
|
||||
An online bookstore.
|
||||
|
||||
## Can
|
||||
- Search catalog
|
||||
- Read book details
|
||||
- Check availability
|
||||
|
||||
## Cannot
|
||||
- Place orders (requires human)
|
||||
|
||||
## Contact
|
||||
hello@mysite.com
|
||||
```
|
||||
|
||||
That's it. Plain text. Human readable.
|
||||
|
||||
## With MCP Gateway
|
||||
|
||||
Point agents to your MCP server for structured tool access:
|
||||
|
||||
```markdown
|
||||
# My Site
|
||||
|
||||
An online bookstore.
|
||||
|
||||
## Can
|
||||
- Search and browse
|
||||
- Check prices
|
||||
- Place orders (authenticated)
|
||||
|
||||
## MCP
|
||||
endpoint: https://mysite.com/.well-known/mcp
|
||||
transport: streamable-http
|
||||
auth: oauth2
|
||||
|
||||
## Contact
|
||||
hello@mysite.com
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
```
|
||||
Agent requests /.well-known/agents.md
|
||||
│
|
||||
├─► Basic: reads text, understands capabilities
|
||||
│
|
||||
└─► Advanced: connects to MCP gateway for tools
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Specification](./spec/README.md) - Full protocol spec
|
||||
- [Examples](./examples/) - Real-world examples
|
||||
- [FAQ](./docs/FAQ.md) - Common questions
|
||||
|
||||
## Status
|
||||
|
||||
**Draft** - Version 0.2.0
|
||||
|
||||
## Related Standards
|
||||
|
||||
- [robots.txt](https://www.rfc-editor.org/rfc/rfc9309) - Crawl restrictions (1994)
|
||||
- [llms.txt](https://llmstxt.org/) - Content for LLMs (2024)
|
||||
- [AGENTS.md](https://agents.md/) - Repository instructions (2025)
|
||||
- [MCP](https://modelcontextprotocol.io/) - Tool protocol (2024)
|
||||
|
||||
## License
|
||||
|
||||
CC0 1.0 Universal - Public Domain
|
||||
Reference in New Issue
Block a user