Skip to content

Commit 615406a

Browse files
authored
Docs requirements (warden-protocol#21)
* added rekquirements for agents * added a header to the readme * a minor fix * udated the requirements list * added an image * a minor fix * minor fixes * minor fixes
1 parent 3645074 commit 615406a

File tree

3 files changed

+23
-3
lines changed

3 files changed

+23
-3
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Warden Community Agents
22

3-
A collection of **Warden Community Agents and Tools** built with TypeScript or Python.
3+
This is a collection of **Warden Community Agents and Tools** built with TypeScript or Python.
44

55
💫 The [Agent Builder Incentive Programme](https://wardenprotocol.org/blog/agent-builder-incentive-programme) is live!
6-
Register now and get paid for building agents! Up to $10,000 in incentives for each agent in the Top 10 in the first month.
6+
[Register now](https://docs.google.com/forms/d/e/1FAIpQLSdwTR0BL8-T3LLbJt6aIyjuEYjMAmJPMdwffwHcyW6gskDQsg/viewform) and get paid for building agents! Up to $10,000 in incentives for each agent in the Top 10 in the first month.
77

88
## 📚 Documentation
99

@@ -27,6 +27,26 @@ Each agent in the [`agents/`](agents) directory is completely self-sufficient an
2727
- **[coingecko-agent](agents/coingecko-agent)**: CoinGecko agent for cryptocurrency data analysis (more complex)
2828
- **[portfolio-agent](agents/portfolio-agent)**: Portfolio agent for cryptocurrency wallet performance analysis (more complex)
2929

30+
## Requirements
31+
32+
When building your agent for the incentive programme, you can implement any Web3 or Web2 workflowand any custom functionality. Your Agent can connect to APIs, use databases, tools, and so on.
33+
34+
Please keep in mind the following requirements and technical limitations:
35+
36+
- At the moment, you must use [LangGraph](https://www.langchain.com/langgraph). Support for more frameworks is coming soon.
37+
- You can [deploy your Agent on LangGraph Cloud or on your own infrastructure ([learn moregit a](docs/deploy-an-agent.md)).
38+
- Make sure that your Agent is accessible through an API. **No UI is required**.
39+
- Make sure that you only have one Agent per LangGraph instance to keep your Agents separated.
40+
- For security reasons, Agents will not have access to users' wallets in the beginning, nor will they be able to store any data on Warden infrastructure.
41+
42+
We'll soon launch **Warden Studio**—a platform where you can register and monetize your Agent. Once it's available, you'll be able to add your Agent directly there, providing just the following:
43+
44+
- Your agent's API URL and API key
45+
- The name, description, and skills
46+
- The avatar
47+
48+
![Registering an Agent in Warden Studio](images/warden-studio.png)
49+
3050
## 🌟 Community Agents and Tools
3151

3252
Awesome agents and tools built by the community! Add yours by submitting a PR to this README file.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To quickly start building with LangGraph, see the following guides:
66

77
- [Get Started with TypeScript LangGraph Agents](langgraph-quick-start.md)
88
- [Get Started with Python LangGraph Agents](langgraph-quick-start-py.md)
9-
- [Deploy an Agent](langgraph-deploy-an-agent.md)
9+
- [Deploy an Agent](deploy-an-agent.md)
1010

1111
**Note**: These guides focus on the essentials: how to deploy and run an agent using LangGraph. If you'd rather skip setup details and dive straight into building real-world agent logic, check out the [Weather Agent example](../agents/weather-agent).
1212

images/warden-studio.png

795 KB
Loading

0 commit comments

Comments
 (0)