The Summoner platform is designed to help you create and run intelligent agents, with a focus on modularity and local-first development. It consists of two core components:
- An SDK for building, customizing, and orchestrating agents
- A Desktop App for managing deployment, testing, and runtime environments
To begin, you can clone the summoner-sdk repository, which contains everything you need to create and run agents. If you prefer managing agents through a graphical interface, visit the summoner-desktop repository. The desktop app is fully functional today, though future versions may require account creation for cloud features.
Note
If you are looking to install and use the desktop app, refer to the Desktop App Guide.
This section of the documentation focuses on the SDK: how to install it, run clients and servers locally, and use sample agents from the summoner-agents repository.
The SDK is modular by design. It is built around a core library (summoner-core) and includes optional components that you can add or remove as needed. This Getting Started section focuses first on the core runtime: clients, servers, routes, flows, and local development. Some later examples may mention optional add-ons such as the agent classes from extension-agentclass, but they are not required for the basic SDK walkthrough. If and when you want those add-ons, their public API is documented in the Agent Extensions reference, including the Aurora module reference.
When you want the exact core SDK surface while reading this guide, jump into the client reference, server reference, and protocol reference.
This section will guide you through:
- Prerequisites: What you need before installing
- Installation: Step-by-step setup instructions
-
Quickstart: Your starting point
-
Basics: Initial concepts and interactions
-
Beginner guide: Foundational ideas
-
Whether you are exploring agent-based programming for the first time or integrating Summoner into a larger system, the pages below will equip you with practical tools and a clear mental model of how everything fits together.
« Previous: Summoner SDK Guides | Next: What Does the Summoner SDK Do? »