|
1 | | -# This repository has been archived |
2 | 1 |
|
3 | | -This project has been consolidated into the [CopilotKit monorepo](https://github.com/CopilotKit/CopilotKit). |
4 | 2 |
|
5 | | -**New location:** [`examples/showcases/multi-agent-canvas`](https://github.com/CopilotKit/CopilotKit/tree/main/examples/showcases/multi-agent-canvas) |
| 3 | +<div align="center"> |
6 | 4 |
|
7 | | -Please open issues and pull requests in the [main CopilotKit repository](https://github.com/CopilotKit/CopilotKit). |
| 5 | +# Open Multi-Agent Canvas |
| 6 | + |
| 7 | + |
| 8 | +</div> |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | +Open Multi-Agent Canvas, created by [CopilotKit](https://github.com/CopilotKit/CopilotKit) is an open-source multi-agent chat interface that lets you manage multiple agents in one dynamic conversation. It's built with Next.js, LangGraph, and CopilotKit to help with travel planning, research, and general-purpose tasks through MCP servers. |
| 15 | + |
| 16 | +## Existing Agents |
| 17 | + |
| 18 | +Check out these awesome agents (they live in separate repositories). You can run them separately or deploy them on LangSmith: |
| 19 | +- [CoAgents Travel Agent](https://github.com/CopilotKit/CopilotKit/tree/main/examples/coagents-travel/agent) |
| 20 | +- [CoAgents AI Researcher](https://github.com/CopilotKit/CopilotKit/tree/main/examples/coagents-ai-researcher/agent) |
| 21 | + |
| 22 | +Additionally, this project now includes a built-in MCP (Multi-Channel Protocol) Agent: |
| 23 | +- **MCP Agent**: A general-purpose agent capable of handling various tasks through configurable MCP servers. |
| 24 | + |
| 25 | +## Copilot Cloud is required to run this project: |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | +## Quick Start 🚀 |
| 31 | + |
| 32 | +### 1. Prerequisites |
| 33 | +Make sure you have: |
| 34 | +- [pnpm](https://pnpm.io/installation) |
| 35 | + |
| 36 | +### 2. API Keys |
| 37 | +- [Copilot Cloud](https://cloud.copilotkit.ai) |
| 38 | + |
| 39 | +## Running the Frontend |
| 40 | + |
| 41 | +Rename the `example.env` file in the `frontend` folder to `.env`: |
| 42 | + |
| 43 | +```sh |
| 44 | +NEXT_PUBLIC_CPK_PUBLIC_API_KEY=... |
| 45 | +``` |
| 46 | + |
| 47 | +Install dependencies: |
| 48 | + |
| 49 | +```sh |
| 50 | +cd frontend |
| 51 | +pnpm i |
| 52 | +``` |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | +Need a CopilotKit API key? Get one [here](https://cloud.copilotkit.ai/). |
| 57 | + |
| 58 | +Then, fire up the Next.js project: |
| 59 | + |
| 60 | +```sh |
| 61 | +pnpm run build && pnpm run start |
| 62 | +``` |
| 63 | + |
| 64 | +## MCP Agent Setup |
| 65 | + |
| 66 | + |
| 67 | + |
| 68 | +The MCP Agent allows you to connect to various MCP-compatible servers: |
| 69 | + |
| 70 | +1. **Configuring Custom MCP Servers**: |
| 71 | + - Click the "MCP Servers" button in the top right of the interface |
| 72 | + - Add servers via the configuration panel: |
| 73 | + - **Standard IO**: Run commands locally (e.g., Python scripts) |
| 74 | + - **SSE**: Connect to external MCP-compatible servers (via Server-Sent Events) |
| 75 | + |
| 76 | +2. **Public MCP Servers**: |
| 77 | + - You can connect to public MCP servers like [mcp.composio.dev](https://mcp.composio.dev/) and [mcp.run](https://www.mcp.run/) |
| 78 | + |
| 79 | +## Running the MCP Agent Backend (Optional) |
| 80 | + |
| 81 | +Rename the `example.env` file in the `agent` folder to `.env`: |
| 82 | + |
| 83 | +```sh |
| 84 | +OPENAI_API_KEY=... |
| 85 | +LANGSMITH_API_KEY=... |
| 86 | +``` |
| 87 | + |
| 88 | +If you want to use the included MCP Agent with the built-in math server: |
| 89 | + |
| 90 | +```sh |
| 91 | +cd agent |
| 92 | +poetry install |
| 93 | +poetry run langgraph dev --host localhost --port 8123 --no-browser |
| 94 | +``` |
| 95 | + |
| 96 | +## Running a tunnel |
| 97 | + |
| 98 | +Add another terminal and select Remote Endpoint. |
| 99 | +Then select Local Development. |
| 100 | +Once this is done, copy the command into your terminal and change the port to match the LangGraph server `8123` |
| 101 | + |
| 102 | + |
| 103 | + |
| 104 | +## Documentation |
| 105 | +- [CopilotKit Docs](https://docs.copilotkit.ai/coagents) |
| 106 | +- [LangGraph Platform Docs](https://langchain-ai.github.io/langgraph/cloud/deployment/cloud/) |
| 107 | +- [Model Context Protocol (MCP) Docs](https://github.com/langchain-ai/langgraph/tree/main/examples/mcp) |
| 108 | + |
| 109 | +## License |
| 110 | +Distributed under the MIT License. See LICENSE for more info. |
| 111 | + |
| 112 | +--- |
| 113 | + |
| 114 | +> **Note:** This project has been consolidated into the [CopilotKit monorepo](https://github.com/CopilotKit/CopilotKit). |
| 115 | +> The latest version lives at [`examples/showcases/multi-agent-canvas`](https://github.com/CopilotKit/CopilotKit/tree/main/examples/showcases/multi-agent-canvas). |
| 116 | +> Please open issues and pull requests in the [main CopilotKit repository](https://github.com/CopilotKit/CopilotKit). |
0 commit comments