# AgentScope Sample Agents [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-) [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE) [![Python](https://img.shields.io/badge/python-%3E%3D3.10-blue)](https://www.python.org/) [![Docs](https://img.shields.io/badge/docs-AgentScope-blue)](https://doc.agentscope.io/) [![Runtime Docs](https://img.shields.io/badge/docs-AgentScope%20Runtime-red)](https://runtime.agentscope.io/) [![Last Commit](https://img.shields.io/github/last-commit/agentscope-ai/agentscope-samples)](https://github.com/agentscope-ai/agentscope-samples) [[δΈ­ζ–‡README]](README_zh.md) Welcome to the **AgentScope Sample Agents** repository! 🎯 This repository provides **ready-to-use Python sample agents** built on top of: - [AgentScope](https://github.com/agentscope-ai/agentscope) - [AgentScope Runtime](https://github.com/agentscope-ai/agentscope-runtime) The examples cover a wide range of use cases β€” from lightweight command-line agents to **full-stack deployable applications** with both backend and frontend. ------ ## πŸ“– About AgentScope & AgentScope Runtime ### **AgentScope** AgentScope is a multi-agent framework designed to provide a **simple and efficient** way to build **LLM-powered agent applications**. It offers abstractions for defining agents, integrating tools, managing conversations, and orchestrating multi-agent workflows. ### **AgentScope Runtime** AgentScope Runtime is a **comprehensive runtime framework** that addresses two key challenges in deploying and operating agents: 1. **Effective Agent Deployment** – Scalable deployment and management of agents across environments. 2. **Sandboxed Tool Execution** – Secure, isolated execution of tools and external actions. It includes **agent deployment** and **secure sandboxed tool execution**, and can be used with **AgentScope** or other agent frameworks. ------ ## ✨ Getting Started - All samples are **Python-based**. - Samples are organized **by functional use case**. - Some samples use only **AgentScope** (pure Python agents). - Others use **both AgentScope and AgentScope Runtime** to implement **full-stack deployable applications** with frontend + backend. - Full-stack runtime versions have folder names ending with: **`_fullstack_runtime`** > πŸ“Œ **Before running** any example, check its `README.md` for installation and execution instructions. ### Install Requirements - [AgentScope Documentation](https://doc.agentscope.io/) - [AgentScope Runtime Documentation](https://runtime.agentscope.io/) ------ ## 🌳 Repository Structure ```bash β”œβ”€β”€ browser_use/ β”‚ β”œβ”€β”€ agent_browser/ # Pure Python browser agent β”‚ └── browser_use_fullstack_runtime/ # Full-stack runtime version with frontend/backend β”‚ β”œβ”€β”€ deep_research/ β”‚ β”œβ”€β”€ agent_deep_research/ # Pure Python multi-agent research β”‚ └── qwen_langgraph_search_fullstack_runtime/ # Full-stack runtime-enabled research app β”‚ β”œβ”€β”€ games/ β”‚ └── game_werewolves/ # Role-based social deduction game β”‚ β”œβ”€β”€ conversational_agents/ β”‚ β”œβ”€β”€ chatbot/ # Chatbot application β”‚ β”œβ”€β”€ chatbot_fullstack_runtime/ # Runtime-powered chatbot with UI β”‚ β”œβ”€β”€ multiagent_conversation/ # Multi-agent dialogue scenario β”‚ └── multiagent_debate/ # Agents engaging in debates β”‚ β”œβ”€β”€ evaluation/ β”‚ └── ace_bench/ # Benchmarks and evaluation tools β”‚ β”œβ”€β”€ functionality/ β”‚ β”œβ”€β”€ long_term_memory_mem0/ # Long-term memory integration β”‚ β”œβ”€β”€ mcp/ # Memory/Context Protocol demo β”‚ β”œβ”€β”€ plan/ # Plan with ReAct Agent β”‚ β”œβ”€β”€ rag/ # RAG in AgentScope β”‚ β”œβ”€β”€ session_with_sqlite/ # Persistent conversation with SQLite β”‚ β”œβ”€β”€ stream_printing_messages/ # Streaming and printing messages β”‚ β”œβ”€β”€ structured_output/ # Structured output parsing and validation β”‚ β”œβ”€β”€ multiagent_concurrent/ # Concurrent multi-agent task execution β”‚ └── meta_planner_agent/ # Planning agent with tool orchestration β”‚ └── README.md ``` ------ ## πŸ“Œ Example List | Category | Example Folder | Uses AgentScope | Use AgentScope Runtime | Description | | ----------------------- |-------------------------------------------------------| --------------- | ------------ |--------------------------------------------------| | **Browser Use** | browser_use/agent_browser | βœ… | ❌ | Command-line browser automation using AgentScope | | | browser_use/browser_use_fullstack_runtime | βœ… | βœ… | Full-stack browser automation with UI & sandbox | | **Deep Research** | deep_research/agent_deep_research | βœ… | ❌ | Multi-agent research pipeline | | | deep_research/qwen_langgraph_search_fullstack_runtime | ❌ | βœ… | Full-stack deep research app | | **Games** | games/game_werewolves | βœ… | ❌ | Multi-agent roleplay game | | **Conversational Apps** | conversational_agents/chatbot_fullstack_runtime | βœ… | βœ… | Chatbot application with frontend/backend | | | conversational_agents/chatbot | βœ… | ❌ | | | | conversational_agents/multiagent_conversation | βœ… | ❌ | Multi-agent dialogue scenario | | | conversational_agents/multiagent_debate | βœ… | ❌ | Agents engaging in debates | | **Evaluation** | evaluation/ace_bench | βœ… | ❌ | Benchmarks with ACE Bench | | **Functionality Demos** | functionality/long_term_memory_mem0 | βœ… | ❌ | Long-term memory with mem0 support | | | functionality/mcp | βœ… | ❌ | Memory/Context Protocol demo | | | functionality/session_with_sqlite | βœ… | ❌ | Persistent context with SQLite | | | functionality/structured_output | βœ… | ❌ | Structured data extraction and validation | | | functionality/multiagent_concurrent | βœ… | ❌ | Concurrent task execution by multiple agents | | | functionality/meta_planner_agent | βœ… | ❌ | Planning agent with tool orchestration | | | functionality/plan | βœ… | ❌ | Task planning with ReAct agent | | | functionality/rag | βœ… | ❌ | Retrieval-Augmented Generation (RAG) integration | | | functionality/stream_printing_messages | βœ… | ❌ | Real-time message streaming and printing | ------ ## ℹ️ Getting Help If you: - Need installation help - Encounter issues - Want to understand how a sample works Please: 1. Read the sample-specific `README.md`. 2. File a [GitHub Issue](https://github.com/agentscope-ai/agentscope-samples/issues). 3. Join the community discussions: | [Discord](https://discord.gg/eYMpfnkG8h) | DingTalk | |----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| | | | ------ ## 🀝 Contributing We welcome contributions such as: - Bug reports - New feature requests - Documentation improvements - Code contributions See the [Contributing](https://github.com/agentscope-ai/agentscope-samples/blob/main/CONTRIBUTING.md) for details. ------ ## πŸ“„ License This project is licensed under the **Apache 2.0 License** – see the [LICENSE](https://github.com/agentscope-ai/agentscope-samples/blob/main/LICENSE) file for details. ------ ## πŸ”— Resources - [AgentScope Documentation](https://doc.agentscope.io/) - [AgentScope Runtime Documentation](https://runtime.agentscope.io/) - [AgentScope GitHub Repository](https://github.com/agentscope-ai/agentscope) - [AgentScope Runtime GitHub Repository](https://github.com/agentscope-ai/agentscope-runtime) ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Weirui Kuang
Weirui Kuang
🚧 πŸ’» πŸ‘€ πŸ“–		 Osier-Yi
Osier-Yi
🚧 πŸ’» πŸ‘€ πŸ“–		 DavdGao
DavdGao
🚧		 qbc
qbc
🚧		 Lamont Huffman
Lamont Huffman
πŸ’» ⚠️
Add your contributions
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!