Getting Started

Welcome to the Agentstr SDK! This guide will walk you through setting up your first agent project with various examples to get you started. Whether you’re new to agent development or looking to integrate advanced functionalities, we’ve got you covered with the following step-by-step guides.

You can find the source code for the examples in the getting_started/ directory of the SDK.

Tip

Before you begin, make sure you have installed the SDK. If not, please see the Installation guide.

Overview of Examples

The Agentstr SDK provides a range of examples to help you understand and implement different agent capabilities:

• Hello World: A basic introduction to setting up and running your first agent. This example covers initializing a project, starting a local relay, running the agent, testing it, and deploying to the cloud. Ideal for beginners. [Learn more]

• Simple Agent: Builds on the basics by customizing the agent’s response. This guide helps you modify the agent’s logic to create a personalized interaction. [Learn more]

• Payment Enabled Agent: Guides you through setting up an agent capable of handling payments with Nostr Wallet Connect (NWC). Learn to integrate payment processing into your agent’s interactions. [Learn more]

• Creating an MCP Server: Learn how to create your own MCP server to provide tools for your agents. [Learn more]

• Tool Calling Agent: Demonstrates how to integrate external tools using the Model Context Protocol (MCP). This example shows how agents can access and utilize various tools for enhanced functionality. [Learn more]

• Custom Framework Agent: Learn how to create a custom framework agent. This example uses the Google ADK, but you can use any agentic framework you want. [Learn more]

Examples

• Hello World
  • Step 1: Initialize Your Project
  • Step 2: Start a Local Relay
  • Step 3: Run Your Agent
  • Step 4: Test Your Agent
  • Step 5 (Optional): Deploy to the Cloud
  • Next Steps
• Simple Agent
  • Step 1: Initialize Your Project
  • Step 2: Update .env file
  • Step 3: Modify the Agent Logic
  • Step 4: Start a Local Relay
  • Step 5: Run Your Simple Agent
  • Step 6: Test Your Agent
  • Step 7 (Optional): Deploy to the Cloud
  • Next Steps
• Payment Enabled Agent
  • Step 1: Initialize Your Project
  • Step 2: Update .env file
  • Step 3: Set Up Payment Integration
  • Step 4: Start a Local Relay
  • Step 5: Run Your Payment-Enabled Agent
  • Step 6: Test Your Agent
  • Step 7 (Optional): Deploy to the Cloud
  • Next Steps
• Creating an MCP Server
  • Step 1: Initialize Your Project
  • Step 2: Update .env File
  • Step 3: Define Your Tools
  • Step 4: Modify the Test Client
  • Step 5: Start a Local Relay
  • Step 6: Run the MCP Server
  • Step 7: Test Your MCP Server
  • Step 8 (Optional): Deploy to the Cloud
  • Next Steps
• Tool Calling Agent
  • Step 1: Initialize Your Project
  • Step 2: Update .env file
  • Step 3: Define Tools for Your Agent
  • Step 4: Update Test Client
  • Step 5: Start a Local Relay
  • Step 6: Run Your Tool-Enabled Agent
  • Step 7: Test Your Agent
  • Step 8 (Optional): Deploy to the Cloud
  • Next Steps
• Custom Framework Agent
  • Step 1: Initialize Your Project
  • Step 2: Update Environment Variables
  • Step 3: Modify the Agent Code
  • Step 4: Update Test Client
  • Step 5: Start a Local Relay
  • Step 6: Run Your Custom Framework Agent
  • Step 7: Test Your Agent
  • Step 8 (Optional): Deploy to the Cloud
  • Next Steps

Next Steps

Congratulations on exploring the getting started guides! Here’s what you can do next:

• Explore the API: Dive into the Core Modules for in-depth API details.

• See More Examples: Check out the Agentstr Cookbook for more comprehensive use cases.

• Deploy to the Cloud: Learn how to deploy your agent with our Cloud CI/CD guide.