Skip to content

Commit b58259c

Browse files
Copilot0xrinegade
andcommitted
Add /docs with markdown documentation for protocol specification and token
Co-authored-by: 0xrinegade <[email protected]>
1 parent 368bcdf commit b58259c

File tree

5 files changed

+876
-0
lines changed

5 files changed

+876
-0
lines changed

docs/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Solana AI Registries Documentation
2+
3+
Welcome to the documentation for the Solana AI Registries protocol. This documentation covers the core specifications, use cases, token utility, and developer resources for working with the Agent Registry and MCP Server Registry protocols.
4+
5+
## Documentation Contents
6+
7+
### Protocol Specifications
8+
- [Protocol Specification](protocol-specification.md) - Comprehensive technical specification of the registry protocols
9+
10+
### Use Cases & Applications
11+
- [Use Cases](use-cases.md) - Detailed exploration of the key use cases and applications
12+
13+
### Token Economics
14+
- [$SVMAI Token](svmai-token.md) - The utility and tokenomics of the $SVMAI token
15+
16+
### Developer Resources
17+
- [Developer Guide](developer-guide.md) - Integration guide for developers building with the registry protocols
18+
19+
## Introduction
20+
21+
The Solana AI Registries protocol is designed to provide essential infrastructure for discovering, verifying, and interacting with autonomous AI agents and Model Context Protocol (MCP) servers. The protocol consists of two interconnected on-chain registries:
22+
23+
1. **Agent Registry**: A decentralized directory for autonomous agents operating on Solana, supporting the advertisement of agent capabilities, endpoints, identity, and metadata following the Autonomous Economic Agent (AEA) and Agent-to-Agent (A2A) paradigms.
24+
25+
2. **MCP Server Registry**: A directory for Model Context Protocol (MCP) compliant servers, enabling the discovery of AI tools, resources, and prompts following the MCP specification.
26+
27+
## Protocol Highlights
28+
29+
- **Hybrid Storage Model**: Essential data on-chain, detailed metadata off-chain with verification hashes
30+
- **Comprehensive Events**: Detailed events for off-chain indexing and querying
31+
- **Standardized Metadata**: Aligned with A2A, AEA, and MCP specifications
32+
- **Ownership Verification**: Clear ownership and access control through Solana key-pairs
33+
- **Extensibility**: Designed for future protocol enhancements and integrations
34+
35+
## Getting Started
36+
37+
For developers looking to integrate with the Solana AI Registries protocol:
38+
39+
1. Start with the [Protocol Specification](protocol-specification.md) to understand the core concepts
40+
2. Explore the [Use Cases](use-cases.md) to identify relevant applications for your project
41+
3. Read the [Developer Guide](developer-guide.md) for integration examples and best practices
42+
4. Learn about the [$SVMAI Token](svmai-token.md) to understand the economic model
43+
44+
## Community & Support
45+
46+
- GitHub Repository: [openSVM/aeamcp](https://github.com/openSVM/aeamcp)
47+
- Documentation Issues: Please report documentation issues via GitHub issues
48+
49+
## Contributing
50+
51+
We welcome contributions to improve the protocol and its documentation:
52+
53+
1. Fork the repository
54+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
55+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
56+
4. Push to the branch (`git push origin feature/amazing-feature`)
57+
5. Open a Pull Request

0 commit comments

Comments
 (0)