Inkeep Agent Framework Template

An Inkeep Agent Framework project with multi-service architecture.

Architecture

This project follows a workspace structure with the following services:

• Agents Manage API (Port 3002): Agent configuration and managemen
  • Handles entity management and configuration endpoints.
• Agents Run API (Port 3003): Agent execution and chat processing
  • Handles agent communication. You can interact with your agents either over MCP from an MCP client or through our React UI components library
• Agents Manage UI (Port 3000): Web interface available via inkeep dev
  • The agent framework visual builder. From the builder you can create, manage and visualize all your graphs.

Quick Start

Follow these steps in the docs to get started with the npx @inkeep/create-agents CLI command.

Deploy using Vercel

1. Prerequisites

Sign up for a cloud hosted deployment for these services:

• Turso on Vercel or directly at Turso Cloud
• SigNoz
• Nango

Follow this guide for how to Deploy the Inkeep Agent Framework to Vercel

Deploy using Docker

Note

Instructions coming soon.

Build and run using Docker locally

1. Complete the quickstart or clone this repository

Follow the quickstart using npx @inkeep/create-agents or clone this repository git clone [email protected]:inkeep/create-agents-template.git

2. Prerequisites

Required: Docker

• Install Docker Desktop

Optional: Self-host SigNoz and Nango

For full functionality, the Inkeep Agent Framework requires SigNoz and Nango. You can sign up for a cloud hosted account with them directly, or you can self host them.

Follow these instructions to self-host both SigNoz and Nango:

1. Clone our repo with the optional docker files for the agent framework:

git clone https://github.com/inkeep/agents-optional-local-dev.git
cd agents-optional-local-dev

2. Create a .env file from the example with an auto-generated NANGO_ENCRYPTION_KEY:

cp .env.example .env && \
  encryption_key=$(openssl rand -base64 32) && \
  sed -i '' "s|<REPLACE_WITH_BASE64_256BIT_ENCRYPTION_KEY>|$encryption_key|" .env && \
  echo "Docker environment file created with auto-generated encryption key"

3. Build and deploy SigNoz, Nango, OTEL Collector, and Jaeger:

docker compose \
  --profile nango \
  --profile signoz \
  --profile otel-collector \
  --profile jaeger \
  up -d

4. Complete environment variables setup Below are important environment variables to be aware of, with the defaults shown.

Follow these steps to find the SIGNOZ_API_KEY for SigNoz:

# SigNoz UI (for Manage UI)
SIGNOZ_URL=http://localhost:3080
SIGNOZ_API_KEY=

Follow these steps to find the NANGO_SECRET_KEY for Nango:

# Nango Configuration (for Run API, Manage API, and Manage UI)
NANGO_SECRET_KEY=
NANGO_SERVER_URL=http://localhost:3050
NANGO_CONNECT_BASE_URL=http://localhost:3051

In addition to the SigNoz and Nango, an OTEL Collector container is also running.

# OTEL Collector (for Run API)
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:14318/v1/traces

Note

SigNoz and Nango run separately. You can get them running before proceeding with running the Inkeep Agent Framework

2. Setup Environment Variables

If you followed the quickstart npx @inkeep/create-agents, you will already have a .env.

But if you need to create one from scratch, generate a .env file from the example:

cp .env.example .env

Then update the .env file with values specific to your environment.

3. Build and run the Inkeep Agent Framework locally

This repostory contains a docker-compose.yml and template Dockerfile for each service:

• Dockerfile.manage-ui
• Dockerfile.manage-api
• Dockerfile.run-ui

To run the Inkeep Agent Framework services:

docker-compose up -d

---

Automated Dependency Updates

This template uses Renovate Bot to automatically create PRs when new @inkeep packages are published.