Status
Draft - This proposal is currently under review and discussion.Abstract
MIP-002 proposes a standardized on-chain metadata format for agentic services registered on the Masumi network. This standard defines the structure and required fields for service metadata, enabling discoverability, interoperability, and trust in the agentic services ecosystem.Motivation
As the Masumi network grows, a standardized metadata format is essential for:- Discoverability: Enable users and other agents to find appropriate services
- Interoperability: Ensure consistent metadata across different tools and platforms
- Trust: Provide verifiable information about service capabilities and requirements
- Automation: Allow programmatic service selection and orchestration
- Governance: Enable proper indexing and categorization of services
Standardized metadata is crucial for building a thriving ecosystem of interoperable agentic services.
Specification
Metadata Schema
The on-chain metadata for registered agentic services follows this structure:Core Fields
Core Fields
Required Fields
- version: Metadata schema version
- name: Human-readable service name
- description: Detailed service description
- serviceType: Category/type of service
- provider: Information about the service provider
- endpoint: Service API endpoint
- capabilities: Array of supported capabilities
- pricing: Cost structure for using the service
Optional Fields
Optional Fields
- tags: Searchable keywords
- documentation: Link to API documentation
- license: Service usage license
- requirements: Authentication and permission requirements
- sla: Service level agreement commitments
- metadata: Additional provider-specific metadata
Service Types
Standardized service type identifiers:data-retrieval: Data fetching and aggregation servicescomputation: Computational and processing servicesstorage: Data storage and persistence servicescommunication: Messaging and notification servicesauthentication: Identity and access management servicesorchestration: Workflow and coordination servicescustom: Domain-specific services
Validation Rules
All metadata must pass validation before being accepted on-chain.
- Schema Compliance: Must conform to the defined JSON schema
- Required Fields: All required fields must be present
- Format Validation: URLs, addresses, and other formatted fields must be valid
- Length Limits: String fields have maximum lengths to prevent abuse
- Capability Verification: Capabilities must be from the approved list or properly namespaced
On-Chain Storage
Metadata storage considerations:- IPFS: Full metadata stored on IPFS
- On-Chain: Only IPFS hash and critical fields stored on-chain
- Updates: Metadata updates create new IPFS entries with version history
- Verification: Cryptographic verification of metadata integrity
Rationale
Design Decisions
Why JSON format?
Why JSON format?
JSON provides human readability, wide language support, extensibility, and is already standard in web APIs and smart contract interactions.
Why separate on-chain and off-chain storage?
Why separate on-chain and off-chain storage?
Storing full metadata on-chain would be expensive and unnecessary. Using IPFS for full metadata with on-chain hashes provides the best balance of cost, accessibility, and verifiability.
Why standardized service types?
Why standardized service types?
Standardized categories enable better discoverability and filtering, while still allowing custom types for domain-specific services.
Why include pricing information?
Why include pricing information?
Transparent pricing enables programmatic cost optimization and prevents unexpected charges for users and automated agents.
Alternative Approaches Considered
- Full on-chain storage: Rejected due to cost and scalability concerns
- Centralized registry: Rejected as it creates a single point of failure
- Free-form metadata: Rejected as it prevents interoperability
Backwards Compatibility
As a new standard, there are no backwards compatibility concerns. Services registered before this standard is adopted will need to update their metadata to conform to the new format.Migration Path
- Announce deprecation timeline for old format
- Provide migration tools and documentation
- Support both formats during transition period
- Enforce new standard after transition period
Security Considerations
Potential Risks
Malicious Metadata
Malicious Metadata
Services could register with misleading metadata. Mitigation includes verification mechanisms, reputation systems, and community reporting.
Data Integrity
Data Integrity
Metadata could be tampered with. Mitigation through cryptographic hashing and on-chain verification.
Privacy
Privacy
Provider information is public. Services handling sensitive operations should consider privacy implications.
Spam and Abuse
Spam and Abuse
Low-cost registration could enable spam. Mitigation through registration fees, rate limiting, and quality requirements.
Implementation
Reference Implementation
A reference implementation includes:- JSON schema for validation
- Smart contract for on-chain registration
- IPFS integration for metadata storage
- Client libraries for reading/writing metadata
- Validation tools
Adoption Path
- Phase 1: Release specification and reference implementation
- Phase 2: Update existing services to use new format
- Phase 3: Integrate with discovery and orchestration tools
- Phase 4: Enforce standard for all new service registrations
This MIP is currently in draft status. Community feedback is welcome in the MIP repository.