agent0-sdk
v1.4.0
Published
TypeScript SDK for agent portability, discovery and trust based on ERC-8004
Maintainers
Readme
Agent0 SDK
Agent0 is the TypeScript SDK for agentic economies. It enables agents to register, advertise their capabilities and how to communicate with them, and give each other feedback and reputation signals. All this using blockchain infrastructure (ERC-8004) and decentralized storage, enabling permissionless discovery without relying on proprietary catalogues or intermediaries.
What Does Agent0 SDK Do?
Agent0 SDK v1.2.0 enables you to:
- Create and manage agent identities - Register your AI agent on-chain with a unique identity, configure presentation fields (name, description, image), set wallet addresses, and manage trust models with x402 support
- Advertise agent capabilities - Publish MCP and A2A endpoints, with automated extraction of MCP tools and A2A skills from endpoints
- OASF taxonomies - Advertise standardized skills and domains using the Open Agentic Schema Framework (OASF) taxonomies for better discovery and interoperability
- Enable permissionless discovery - Make your agent discoverable by other agents and platforms using rich search by attributes, capabilities, skills, tools, tasks, and x402 support
- Build reputation - Give and receive feedback, retrieve feedback history, and search agents by reputation with cryptographic authentication
- Cross-chain registration - One-line registration with IPFS nodes, Pinata, Filecoin, or HTTP URIs
- Public indexing - Subgraph indexing both on-chain and IPFS data for fast search and retrieval
⚠️ Beta Release
Agent0 SDK v1.2.0 is beta. We're actively testing and improving it.
For breaking changes and migration notes, see release_notes/RELEASE_NOTES_1.2.0.md and prior notes in release_notes/.
Bug reports & feedback: GitHub: Report issues | Telegram: Agent0 channel | Email: [email protected]
Installation
Prerequisites
- Node.js 22 or higher
- npm or yarn package manager
- Private key for signing transactions (or run in read-only mode)
- Access to an Ethereum RPC endpoint (e.g., Alchemy, Infura)
- (Optional) IPFS provider account (Pinata, Filecoin, or local IPFS node)
Install from npm
npm install agent0-sdkNote: This package is an ESM (ECMAScript Module) package. Use import statements in your code:
import { SDK } from 'agent0-sdk';Install from Source
git clone https://github.com/agent0lab/agent0-ts.git
cd agent0-ts
npm install
npm run buildNote: The generated TypeScript types are created as part of npm run build (or manually with npm run codegen). Always use npm run build instead of running tsc directly.
Quick Start
1. Initialize SDK (server-side)
import { SDK } from 'agent0-sdk';
// Initialize SDK with IPFS and subgraph
const sdk = new SDK({
chainId: 11155111, // Ethereum Sepolia testnet
rpcUrl: process.env.RPC_URL!,
privateKey: process.env.PRIVATE_KEY ?? process.env.AGENT_PRIVATE_KEY, // Optional: for write operations
ipfs: 'pinata', // Options: 'pinata', 'filecoinPin', 'node'
pinataJwt: process.env.PINATA_JWT // For Pinata
// Subgraph URL auto-defaults from DEFAULT_SUBGRAPH_URLS
});1b. Initialize SDK (browser-side with ERC-6963 wallets)
In the browser you typically keep reads on your rpcUrl and use a wallet (EIP-1193) for writes.
import { SDK } from 'agent0-sdk';
import { discoverEip6963Providers, connectEip1193 } from 'agent0-sdk/eip6963';
const providers = await discoverEip6963Providers();
if (providers.length === 0) throw new Error('No injected wallets found');
// Pick a wallet (UI selection recommended)
const { provider } = providers[0];
await connectEip1193(provider); // prompts user
const sdk = new SDK({
chainId: 11155111,
rpcUrl: 'https://sepolia.infura.io/v3/YOUR_PROJECT_ID',
walletProvider: provider,
});2. Create and Register Agent
// Create agent
const agent = sdk.createAgent(
'My AI Agent',
'An intelligent assistant for various tasks. Skills: data analysis, code generation.',
'https://example.com/agent-image.png'
);
// Configure endpoints (automatically extracts capabilities)
await agent.setMCP('https://mcp.example.com/'); // Extracts tools, prompts, resources
await agent.setA2A('https://a2a.example.com/agent-card.json'); // Extracts skills
agent.setENS('myagent.eth');
// Add OASF skills and domains (standardized taxonomies)
agent.addSkill('data_engineering/data_transformation_pipeline', true);
agent.addSkill('natural_language_processing/natural_language_generation/summarization', true);
agent.addDomain('finance_and_business/investment_services', true);
agent.addDomain('technology/data_science/data_science', true);
// Optionally set a dedicated agent wallet on-chain (requires new wallet signature).
// If you want agentWallet = owner wallet, you can skip this (contract sets initial value to owner).
// await agent.setWallet('0x...', { newWalletPrivateKey: process.env.NEW_WALLET_PRIVATE_KEY });
agent.setTrust(true, true, false); // reputation, cryptoEconomic, teeAttestation
// Add metadata and set status
agent.setMetadata({ version: '1.0.0', category: 'ai-assistant' });
agent.setActive(true);
// Register on-chain with IPFS
const registrationFile = await agent.registerIPFS();
console.log(`Agent registered: ${registrationFile.agentId}`); // e.g., "11155111:123"
console.log(`Agent URI: ${registrationFile.agentURI}`); // e.g., "ipfs://Qm..."3. Load and Edit Agent
// Load existing agent for editing
const agent = await sdk.loadAgent('11155111:123'); // Format: "chainId:agentId"
// Edit agent properties
agent.updateInfo(undefined, 'Updated description with new capabilities', undefined);
await agent.setMCP('https://new-mcp.example.com/');
// Re-register to update on-chain
await agent.registerIPFS();
console.log(`Updated: ${agent.agentURI}`);4. Search Agents
// Search by name, capabilities, or attributes (single chain)
const results = await sdk.searchAgents({
name: 'AI', // Substring search
mcpTools: ['code_generation'], // Specific MCP tools
a2aSkills: ['python'], // Specific A2A skills
active: true, // Only active agents
x402support: true // Payment support
});
for (const agent of results.items) {
console.log(`${agent.name}: ${agent.description}`);
console.log(` Tools: ${agent.mcpTools?.join(', ')}`);
console.log(` Skills: ${agent.a2aSkills?.join(', ')}`);
}
// Multi-chain search
const multiChainResults = await sdk.searchAgents({
active: true,
chains: [11155111, 84532, 80002] // ETH Sepolia, Base Sepolia, Polygon Amoy
// Or use 'all' to search all configured chains: chains: 'all'
});
console.log(`Found ${multiChainResults.items.length} agents across chains`);
if (multiChainResults.meta) {
console.log(`Successful chains: ${multiChainResults.meta.successfulChains.join(', ')}`);
}
// Get single agent (read-only, faster)
// Supports chainId:agentId format
const agentSummary = await sdk.getAgent('11155111:123'); // Default chain
const baseAgent = await sdk.getAgent('84532:123'); // Base Sepolia4a. Multi-Chain Search
// Search across multiple chains
const results = await sdk.searchAgents({
active: true,
chains: [11155111, 84532] // ETH Sepolia and Base Sepolia
});
// Search all configured chains
const allResults = await sdk.searchAgents({
active: true,
chains: 'all' // Searches all configured chains
});
// Search agents by reputation across chains
const reputationResults = await sdk.searchAgentsByReputation(
{ minAverageValue: 80 },
{ includeRevoked: false, pageSize: 20, chains: [11155111, 84532] }
);
// Get agent from specific chain
const agent = await sdk.getAgent('84532:123'); // Base Sepolia
// Search feedback for a specific agent (unchanged)
const feedbacks = await sdk.searchFeedback({ agentId: '84532:123' }); // Base Sepolia
// NEW: Search feedback given by a reviewer wallet (across all agents)
const givenFeedback = await sdk.searchFeedback({
reviewers: ['0x742d35cc6634c0532925a3b844bc9e7595f0beb7'],
});
// NEW: Search feedback across multiple agents at once
const multiFeedback = await sdk.searchFeedback({
agents: ['84532:123', '84532:456', '84532:789'],
});
// Get reputation summary for agent on specific chain
const summary = await sdk.getReputationSummary('84532:123'); // Base Sepolia5. Give and Retrieve Feedback
// Optional: prepare an OFF-CHAIN feedback file (only needed for rich fields)
const feedbackFile = sdk.prepareFeedbackFile({
capability: 'tools',
name: 'code_generation',
skill: 'python',
context: { sessionId: 'abc' },
});
// Give feedback (on-chain fields are passed directly)
const tx = await sdk.giveFeedback(
'11155111:123',
85, // value (number|string)
'data_analyst', // tag1 (optional)
'finance', // tag2 (optional)
'https://api.example.com/feedback', // endpoint (optional on-chain)
feedbackFile // optional off-chain file
);
// Submitted-by-default: wait explicitly for confirmation to get a receipt + the domain result
const { receipt, result: feedback } = await tx.waitConfirmed();
// Search feedback
const feedbackResults = await sdk.searchFeedback(
{ agentId: '11155111:123', capabilities: ['tools'] },
{ minValue: 80, maxValue: 100 }
);
// Get reputation summary
const summary = await sdk.getReputationSummary('11155111:123');
console.log(`Average value: ${summary.averageValue}`);IPFS Configuration Options
// Option 1: Filecoin Pin (free for ERC-8004 agents)
const sdk = new SDK({
chainId: 11155111,
rpcUrl: '...',
signer: privateKey,
ipfs: 'filecoinPin',
filecoinPrivateKey: 'your-filecoin-private-key'
});
// Option 2: IPFS Node
const sdk = new SDK({
chainId: 11155111,
rpcUrl: '...',
signer: privateKey,
ipfs: 'node',
ipfsNodeUrl: 'https://ipfs.infura.io:5001'
});
// Option 3: Pinata (free for ERC-8004 agents)
const sdk = new SDK({
chainId: 11155111,
rpcUrl: '...',
signer: privateKey,
ipfs: 'pinata',
pinataJwt: 'your-pinata-jwt-token'
});
// Option 4: HTTP registration (no IPFS)
const sdk = new SDK({ chainId: 11155111, rpcUrl: '...', signer: privateKey });
const regTx = await agent.registerHTTP('https://example.com/agent-registration.json');
await regTx.waitConfirmed();Multi-Chain Support
The SDK supports querying agents across multiple blockchain networks:
- Ethereum Sepolia (Chain ID:
11155111) - Base Sepolia (Chain ID:
84532) - Polygon Amoy (Chain ID:
80002)
Chain-Agnostic Agent IDs
Use chainId:agentId format to specify which chain an agent is on:
// Get agent from specific chain
const agent = await sdk.getAgent('84532:1234'); // Base Sepolia
// Search feedback for agent on specific chain
const feedbacks = await sdk.searchFeedback({ agentId: '84532:1234' }); // Base Sepolia
const feedbacksDefault = await sdk.searchFeedback({ agentId: '11155111:1234' }); // Default chain
// Get reputation summary for agent on specific chain
const summary = await sdk.getReputationSummary('84532:1234'); // Base Sepolia
const summaryDefault = await sdk.getReputationSummary('1234'); // Uses default chainMulti-Chain Search
Search across multiple chains simultaneously:
// Search across multiple chains
const result = await sdk.searchAgents({
active: true,
chains: [11155111, 84532] // ETH Sepolia and Base Sepolia
});
// Search all configured chains
const allChainsResult = await sdk.searchAgents({
active: true,
chains: 'all' // Searches all configured chains
});
// Multi-chain reputation search
const reputationResult = await sdk.searchAgentsByReputation(
{ minAverageValue: 80 },
{ includeRevoked: false, pageSize: 20, chains: [11155111, 84532] }
);
// Search all chains for agents with reputation
const allChainsReputation = await sdk.searchAgentsByReputation(
{ minAverageValue: 80 },
{ includeRevoked: false, pageSize: 20, chains: 'all' }
);
// Access metadata about queried chains
if (result.meta) {
console.log(`Queried chains: ${result.meta.chains.join(', ')}`);
console.log(`Successful: ${result.meta.successfulChains.join(', ')}`);
console.log(`Failed: ${result.meta.failedChains.join(', ')}`);
console.log(`Total results: ${result.meta.totalResults}`);
console.log(`Query time: ${result.meta.timing.totalMs}ms`);
}Default Chain Behavior
When you initialize the SDK, you specify a default chain. Agent IDs without a chainId: prefix use the default chain:
const sdk = new SDK({
chainId: 11155111, // Default chain
rpcUrl: 'https://eth-sepolia.g.alchemy.com/v2/YOUR_KEY'
});
// Uses default chain (11155111)
const agent = await sdk.getAgent('1234'); // Equivalent to "11155111:1234"
// Explicitly specify different chain
const agent = await sdk.getAgent('84532:1234'); // Base SepoliaOASF Taxonomies
The SDK includes support for the Open Agentic Schema Framework (OASF) taxonomies, enabling agents to advertise standardized skills and domains. This improves discoverability and interoperability across agent platforms.
Adding Skills and Domains
// Add OASF skills (with optional validation)
agent.addSkill('advanced_reasoning_planning/strategic_planning', true);
agent.addSkill('data_engineering/data_transformation_pipeline', true);
// Add OASF domains (with optional validation)
agent.addDomain('finance_and_business/investment_services', true);
agent.addDomain('technology/data_science/data_visualization', true);
// Remove skills/domains
agent.removeSkill('old_skill');
agent.removeDomain('old_domain');OASF in Registration Files
OASF skills and domains appear in your agent's registration file:
{
"endpoints": [
{
"name": "OASF",
"endpoint": "https://github.com/agntcy/oasf/",
"version": "v0.8.0",
"skills": [
"advanced_reasoning_planning/strategic_planning",
"data_engineering/data_transformation_pipeline"
],
"domains": [
"finance_and_business/investment_services",
"technology/data_science/data_science"
]
}
]
}Taxonomy Files
The SDK includes complete OASF v0.8.0 taxonomy files:
- Skills:
src/taxonomies/all_skills.json(136 skills) - Domains:
src/taxonomies/all_domains.json(204 domains)
Browse these files to find appropriate skill and domain slugs. For more information, see the OASF specification and release_notes/RELEASE_NOTES_0.31.md.
🚀 Coming Soon
- Support for validations
- Enhanced x402 payments
- Semantic/Vectorial search
- Advanced reputation aggregation
- Import/Export to centralized catalogues
Examples
Complete working examples are available in the examples/ directory:
quick-start.ts- Basic agent creation and registrationagent-update.ts- Agent registration with IPFSfeedback-usage.ts- Complete feedback flow with IPFS storagesearch-agents.ts- Agent search and discoverytransfer-agent.ts- Agent ownership transfer
Documentation
Full documentation is available at sdk.ag0.xyz, including:
License
Agent0 SDK is MIT-licensed public good brought to you by Marco De Rossi in collaboration with Consensys, 🦊 MetaMask and Agent0, Inc. We are looking for co-maintainers. Please reach out if you want to help.
Thanks also to Edge & Node (The Graph), Protocol Labs and Pinata for their support.
