Inkeep Agent Platform

https://docs.inkeep.com/
Admin
Inkeep is a platform for creating and managing flexible AI agents using a No-Code Visual Builder or...
Tokens:137,710
Snippets:783
Trust Score:8.4
Update:11 months ago
Show doc for...
Tokens:
Raw
### Verify Prerequisites

Source: https://docs.inkeep.com/get-started/quick-start

Check if Node.js, pnpm, and Docker are installed and meet the version requirements. This is essential before proceeding with the agent setup.

```bash
node --version
pnpm --version
docker --version
```

--------------------------------

### Create and Set Up Inkeep Agents Project (Bash)

Source: https://docs.inkeep.com/quick-start/start-development

This snippet guides you through creating a new Inkeep agents project using npx and then navigating into the project directory. It requires Node.js and pnpm to be installed.

```bash
npx @inkeep/create-agents my-agents 
cd my-agents
```

--------------------------------

### Clone Repository and Setup Development Environment

Source: https://docs.inkeep.com/community/contributing/overview

Clone the Inkeep agent repository and set up the development environment. This involves installing Node.js, Docker, pnpm, and running a setup script that configures environment variables, installs dependencies, and initializes the database.

```bash
git clone https://github.com/inkeep/agents.git
cd agents
pnpm setup-dev

# Add API keys to .env file
# ANTHROPIC_API_KEY=sk-ant-xyz789
# OPENAI_API_KEY=sk-xxx
# GOOGLE_GENERATIVE_AI_API_KEY=sk-xxx
# SIGNOZ_API_KEY=sk-xxx (optional)
# NANGO_SECRET_KEY=sk-xxx (optional)
```

--------------------------------

### Run Inkeep Development Setup Script (Bash)

Source: https://docs.inkeep.com/quick-start/start-development

Executes the setup script for the Inkeep development environment. This command assumes you are within your Inkeep agent project directory. It is a prerequisite for launching the development environment.

```bash
pnpm setup-dev
```

--------------------------------

### Install Inkeep CLI Globally (Bash)

Source: https://docs.inkeep.com/quick-start/start-development

Installs the Inkeep CLI tool globally on your system using npm. This command allows you to manage and deploy your Inkeep agent projects from the command line.

```bash
npm install -g @inkeep/agents-cli
```

--------------------------------

### Push Inkeep Agent Project to Visual Builder (Bash)

Source: https://docs.inkeep.com/quick-start/start-development

Navigates into the specific agent project directory (e.g., 'src/weather-project') and pushes the defined agent and tool code to the Inkeep Visual Builder. This command requires the Inkeep CLI to be installed globally.

```bash
cd src/weather-project
inkeep push
```

--------------------------------

### Install Inkeep Agents MCP for Claude Code

Source: https://docs.inkeep.com/get-started/quick-start

Add the Inkeep Agents MCP to your Claude Code IDE using the provided command. This integrates Inkeep's functionality directly into your coding environment.

```bash
claude mcp add --transport http inkeep-agents https://agents.inkeep.com/mcp --scope project
```

--------------------------------

### MCP Server Configuration for Cursor

Source: https://docs.inkeep.com/talk-to-your-agents/mcp-server

Configure the MCP server in Cursor using either the quick install method or manual configuration. Includes setup steps for both API key and development authentication modes.

```APIDOC
## MCP Server Configuration for Cursor

### Description
Configure the Inkeep Agents MCP server in Cursor IDE to enable agent communication and tool discovery.

### Quick Install
One-click installation for Inkeep Hosted Docs MCP:
- Cursor: Visit the Inkeep Agents MCP install link
- VS Code: Use the Install in VS Code badge

### Manual Configuration
Add the following configuration to your Cursor MCP settings file.

### Configuration File Location
`~/.cursor/mcp.json` or Cursor Settings → MCP Servers

### Configuration with API Key
```json
{
  "AgentName": {
    "type": "mcp",
    "url": "http://<your-run-api-url>/v1/mcp",
    "headers": {
      "Authorization": "Bearer <agent_api_key>"
    }
  }
}
```

### Configuration for Local Development
```json
{
  "LocalAgent": {
    "type": "mcp",
    "url": "http://localhost:3003/v1/mcp",
    "headers": {
      "x-inkeep-tenant-id": "<tenant-id>",
      "x-inkeep-project-id": "<project-id>",
      "x-inkeep-agent-id": "<agent-id>"
    }
  }
}
```

### Configuration Parameters
- **type** (string) - Must be "mcp"
- **url** (string) - Full URL to your agents-run-api instance (default: http://localhost:3003)
- **headers** (object) - Authentication headers (see Authentication section)

### Usage
Once configured, Cursor automatically discovers the send-query-to-agent tool. Ask questions naturally and the tool will route queries to your agent's sub-agent and return responses.

### Configuration Notes
- **URL**: Point to your `agents-run-api` instance
- **Headers**: Use appropriate authentication mode
- **Authorization**: Only required outside development mode
- **Development Mode**: Use custom headers only when running locally with `pnpm dev`
```

--------------------------------

### Launch Inkeep Development Environment (Bash)

Source: https://docs.inkeep.com/quick-start/start-development

Starts the Inkeep development environment, which includes the Visual Builder, Manage API, and Run API services. The Visual Builder will automatically open in your browser at http://localhost:3000. Ensure necessary ports are available.

```bash
pnpm dev
```

--------------------------------

### Install Docker Packages on Ubuntu

Source: https://docs.inkeep.com/self-hosting/hetzner

Installs Docker Community Edition, CLI tools, containerd runtime, and Docker Compose plugin. Run this after configuring Docker's APT repository.

```bash
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
```

--------------------------------

### Start Local SigNoz Services with Docker

Source: https://docs.inkeep.com/get-started/traces

Docker Compose command to start SigNoz and related services locally, including the frontend, query service, OTEL collector, and ClickHouse database. The frontend becomes accessible at http://localhost:3080.

```bash
docker-compose --profile signoz up -d
```

--------------------------------

### Install Vercel AI Elements CLI

Source: https://docs.inkeep.com/talk-to-your-agents/vercel-ai-sdk/ai-elements

This command-line instruction installs the Vercel AI Elements package and adds selected components to your project. It typically places them under `@/components/ai-elements/` and configures any necessary shadcn/ui primitives.

```sh
npx ai-elements@latest
```

--------------------------------

### Create New Inkeep Agents Project

Source: https://docs.inkeep.com/get-started/quick-start

Use the Inkeep CLI to generate a new agents project in a specified directory. This command initializes the project structure for your Inkeep agent.

```bash
npx @inkeep/create-agents my-agents
```

--------------------------------

### Install Inkeep CLI and Dashboard

Source: https://docs.inkeep.com/typescript-sdk/cli-reference

Commands to install the Inkeep CLI globally and the dashboard package for visual orchestration. Uses npm for package management.

```bash
# Install the CLI globally
npm install -g @inkeep/agents-cli

# Install the dashboard package (for visual agents orchestration)
npm install @inkeep/agents-manage-ui
```

--------------------------------

### Start SigNoz, Nango, and Other Services with Docker Compose

Source: https://docs.inkeep.com/self-hosting/docker-local

Builds and starts the Docker containers for SigNoz, Nango, OTEL Collector, and Jaeger. This command ensures all required external services are running in detached mode.

```bash
docker compose up -d
```

--------------------------------

### Install Vercel AI SDK for React

Source: https://docs.inkeep.com/talk-to-your-agents/vercel-ai-sdk/use-chat

Install the necessary packages for the Vercel AI SDK in your React application using npm. This command adds the core `ai` package and the React-specific bindings.

```bash
npm install ai @ai-sdk/react
```

--------------------------------

### Inkeep Environment Configuration File Example

Source: https://docs.inkeep.com/typescript-sdk/cli-reference

An example TypeScript file demonstrating how to register environment-specific settings, including credentials, for use with the Inkeep CLI. This file is typically located within the `environments/` directory of a project.

```typescript
// environments/development.env.ts
import { CredentialStoreType } from "@inkeep/agents-core";
import { registerEnvironmentSettings } from "@inkeep/agents-sdk";

export const development = registerEnvironmentSettings({
  credentials: {
    "api-key-dev": {
      id: "api-key-dev",
      type: CredentialStoreType.memory,
      credentialStoreId: "memory-default",
      retrievalParams: {
        key: "API_KEY_DEV",
      },
    },
  },
});
```

--------------------------------

### Navigate to Project Directory

Source: https://docs.inkeep.com/get-started/quick-start

Change the current directory to the newly created agents project folder. This is a standard command-line operation to access project files.

```bash
cd my-agents
```

--------------------------------

### Start Nango Local Services (Bash)

Source: https://docs.inkeep.com/typescript-sdk/credentials/nango

Start the Nango services using Docker Compose within the cloned repository. This command ensures that Nango is running locally for development purposes.

```bash
docker-compose --profile nango up -d
```

--------------------------------

### Span Naming Convention Examples

Source: https://docs.inkeep.com/community/contributing/spans

Illustrates the recommended hierarchical naming convention for spans, using underscores for multi-word functions and lowercase. Examples cover agent and context operations.

```typescript
// Format: 'class.function'
// Use descriptive span names that follow a hierarchical structure

// Agent operations
"agent.generate";
"agent.tool_execute";
"agent.transfer";

// Context operations
"context.resolve";
"context.fetch";
```

--------------------------------

### Install Datadog APM Package

Source: https://docs.inkeep.com/self-hosting/add-other-services/datadog-apm

Installs the Datadog APM tracing library for Node.js. This is a prerequisite for enabling distributed tracing and monitoring within the Inkeep Agent Framework.

```bash
pnpm install dd-trace
```

--------------------------------

### Example Headers for Multi-tenant Applications in TypeScript

Source: https://docs.inkeep.com/typescript-sdk/headers

This snippet provides example header values for a multi-tenant application scenario. It includes headers such as 'tenant_id', 'tenant_plan', and 'tenant_features', demonstrating how to pass tenant-specific configuration that can be used to customize agent behavior for different customers.

```typescript
// Headers
"tenant_id: acme-corp"
"tenant_plan: enterprise"
"tenant_features: advanced-analytics,custom-branding"
```

--------------------------------

### Complete React Chat UI Example

Source: https://docs.inkeep.com/talk-to-your-agents/vercel-ai-sdk/use-chat

A full React component example demonstrating a complete chat interface using the `useChat` hook from the AI SDK. It includes conversation management, message display, and an input form for sending messages, along with custom styling.

```tsx
"use client";

import { useChat } from "@ai-sdk/react";
import { DefaultChatTransport } from "ai";
import { useState } from "react";

export default function Page() {
  const { messages, sendMessage } = useChat({
    transport: new DefaultChatTransport({
      api: "{process.env.NEXT_PUBLIC_INKEEP_AGENTS_RUN_API_URL}/api/chat",
      headers: {
        "x-inkeep-tenant-id": "default",
        "x-inkeep-project-id": "activities-planner",
        "x-inkeep-agent-id": "activities-planner",
        tz: "US/Pacific",
      },
    }),
  });
  const [input, setInput] = useState("");

  return (
    <div className="max-w-2xl mx-auto p-4">
      <div className="space-y-4 mb-4">
        {messages.map((message) => (
          <div key={message.id} className="border rounded p-3">
            <div className="font-semibold mb-2">
              {message.role === "user" ? "👤 User" : "🤖 Assistant"}
            </div>

            <div className="space-y-2">
              {message.parts.map((part, partIndex) => {
                const partKey = `${message.id}-${part.type}-${partIndex}`;

                if (part.type === "text") {
                  return (
                    <div key={partKey} className="whitespace-pre-wrap">
                      {part.text}
                    </div>
                  );
                }

                if (part.type?.startsWith("data-")) {
                  return (
                    <div
                      key={partKey}
                      className="bg-blue-50 p-3 rounded border-l-4 border-blue-400"
                    >
                      <div className="font-semibold text-blue-700">
                        Data: {JSON.stringify(part, null, 2)}
                      </div>
                    </div>
                  );
                }
                return null;
              })}
            </div>
          </div>
        ))}
      </div>

      <form
        onSubmit={(e) => {
          e.preventDefault();
          if (input.trim()) {
            sendMessage({ text: input });
            setInput("");
          }
        }}
        className="flex gap-2"
      >
        <input
          value={input}
          onChange={(e) => setInput(e.target.value)}
          placeholder="Ask about weather, request confirmation, or ask for location..."
          className="flex-1 p-2 border rounded"
        />
        <button
          type="submit"
          className="px-4 py-2 bg-blue-500 text-white rounded hover:bg-blue-600"
        >
          Send
        </button>
      </form>

      <div className="mt-4 text-sm text-gray-600">
        <p>Try asking:</p>
        <ul className="list-disc list-inside space-y-1">
          <li>"What's the weather in New York?"</li>
          <li>"Can you get my location?"</li>
          <li>"Ask me to confirm something"</li>
        </ul>
      </div>
    </div>
  );
}
```

--------------------------------

### Example Headers for API Gateway Integration in TypeScript

Source: https://docs.inkeep.com/typescript-sdk/headers

This code snippet presents example headers commonly used when integrating with an API gateway. It includes headers such as 'x-api-key', 'x-request-id', and 'x-client-version', illustrating how to forward headers from an API gateway to ensure consistent authentication and request tracking.

```typescript
// Headers
"x-api-key: your-api-key"
"x-request-id: req_abc123"
"x-client-version: 2.0.0"
```

--------------------------------

### User-Friendly Status Update Examples in TypeScript

Source: https://docs.inkeep.com/typescript-sdk/structured-outputs/status-updates

Illustrative examples of user-friendly status messages in TypeScript, contrasting effective, descriptive, and actionable updates with less effective, overly technical, or vague ones. These examples guide developers in crafting clear communication for users during agent operations.

```typescript
// Good: Descriptive and actionable
"Searching through documentation to find API authentication methods...";
"Found OAuth2 setup prompt, now checking for code examples...";

// Avoid: Too technical or vague
"Agent thinking...";
"Processing data-operation with tool_invocation type...";
```

--------------------------------

### Set up Live Traces with Docker and SigNoz

Source: https://docs.inkeep.com/community/contributing/overview

Launches Docker containers for live traces, fetches an API key from SigNoz, and configures the environment variable to enable trace visualization within the Inkeep Agent Framework.

```bash
cd deploy/docker
docker compose up -d

# After fetching SigNoz API key from http://localhost:3080:
# Create or update .env file at /agents-manage-ui/
# SIGNOZ_API_KEY=your-signoz-api-key-here
```

--------------------------------

### Example: Branded Tone Status Update Prompt in TypeScript

Source: https://docs.inkeep.com/typescript-sdk/structured-outputs/status-updates

Shows how to configure a status update prompt to adopt a specific tone, such as friendly and helpful, and to start updates with action words. This personalizes the agent's communication style.

```typescript
statusUpdates: {
  prompt: 'Use a friendly, helpful tone. Start updates with action words like "Discovering", "Exploring", "Analyzing".',
}
// Results in: "Discovering relevant documentation...", "Analyzing search results for best matches"
```

--------------------------------

### Parse Server-Sent Events Stream - Text and Data Events

Source: https://docs.inkeep.com/talk-to-your-agents/chat-api

Example of a complete SSE stream showing text streaming with interspersed data events. The stream uses keep-alive headers and emits text in three-stage pattern (start, delta chunks, end) followed by operational, summary, component, and artifact events. This demonstrates the typical event flow from an Inkeep agent.

```text
: keep-alive

data: {"type":"text-start","id":"1726247200-abc123"}

data: {"type":"text-delta","id":"1726247200-abc123","delta":"Hello! I can help with..."}

data: {"type":"data-summary","data":{"label":"Searching documentation","details":{"summary":"Looking for relevant information","progress":"25%"}}}

data: {"type":"text-delta","id":"1726247200-abc123","delta":" analyzing your query..."}

data: {"type":"text-end","id":"1726247200-abc123"}

data: {"type":"data-operation","data":{"type":"completion","ctx":{"agent":"search-agent","iteration":1}}}

data: {"type":"data-component","id":"1726247200-abc123-0","data":{"type":"customer-info","name":"Ada","email":"ada@example.com"}}

data: {"type":"data-artifact","data":{"artifact_id":"art_abc","task_id":"task_xyz","summary":{"title":"Search Results"}}}
```

--------------------------------

### Configure Local SigNoz Environment Variables

Source: https://docs.inkeep.com/get-started/traces

Set up environment variables for local SigNoz deployment using localhost. The cloud OTEL configuration lines should be commented out to avoid conflicts with the local setup.

```bash
# SigNoz Configuration
SIGNOZ_URL=http://localhost:3080
SIGNOZ_API_KEY=your-signoz-api-key

# IMPORTANT: Comment out the OTEL Configuration
# OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://ingest.us.signoz.cloud:443/v1/traces
# OTEL_EXPORTER_OTLP_TRACES_HEADERS="signoz-ingestion-key=<your-ingestion-key>"
```

--------------------------------

### Install Pino Sentry Transport

Source: https://docs.inkeep.com/self-hosting/add-other-services/sentry

Installs the pino-sentry-transport package, which allows you to forward your application's logs to Sentry.

```bash
pnpm install pino-sentry-transport
```

--------------------------------

### Set Up Inkeep Agent Framework Docker Compose Configuration

Source: https://docs.inkeep.com/self-hosting/docker-local

Downloads the docker-compose.yml and .env.docker.example files for the Inkeep Agent Framework and copies the example to a new .env file. This prepares the framework for local deployment.

```bash
mkdir inkeep && cd inkeep
wget https://raw.githubusercontent.com/inkeep/agents/refs/heads/main/docker-compose.yml
wget https://raw.githubusercontent.com/inkeep/agents/refs/heads/main/.env.docker.example
cp .env.docker.example .env
```

--------------------------------

### Install Sentry Node.js SDK

Source: https://docs.inkeep.com/self-hosting/add-other-services/sentry

Installs the Sentry Node.js SDK, which is required for integrating Sentry error tracking into your application.

```bash
pnpm install @sentry/node
```

--------------------------------

### Install Inkeep Agents UI

Source: https://docs.inkeep.com/talk-to-your-agents/react/embedded-chat

Installs the necessary Inkeep agents UI package for React applications using npm, yarn, or pnpm.

```bash
npm install @inkeep/agents-ui
```

```bash
yarn add @inkeep/agents-ui
```

```bash
pnpm add @inkeep/agents-ui
```

--------------------------------

### Set up Docker's APT Repository on Ubuntu

Source: https://docs.inkeep.com/self-hosting/hetzner

Adds Docker's official GPG key and repository to Ubuntu's package manager. This is required before installing Docker packages. Includes commands to update package lists and add the Docker repository sources.

```bash
# Add Docker's official GPG key:
sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add the repository to Apt sources:
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
```

--------------------------------

### Configure SigNoz Cloud Environment Variables

Source: https://docs.inkeep.com/get-started/traces

Set up environment variables for SigNoz Cloud integration including the SigNoz URL, API key, and OpenTelemetry exporter configuration with ingestion credentials. These variables enable trace export to your SigNoz Cloud instance.

```bash
# SigNoz
SIGNOZ_URL=https://<your-organization>.signoz.cloud
SIGNOZ_API_KEY=<your-api-key>

OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://ingest.us.signoz.cloud:443/v1/traces
OTEL_EXPORTER_OTLP_TRACES_HEADERS="signoz-ingestion-key=<your-ingestion-key>"
```

--------------------------------

### Manage Inkeep Configuration: Get Values

Source: https://docs.inkeep.com/typescript-sdk/cli-reference

Retrieves Inkeep configuration values. You can get all values by omitting the key, or a specific value by providing its key. Supports specifying a configuration file path.

```bash
# Get all config values
inkeep config get

# Get specific value
inkeep config get tenantId
```

--------------------------------

### Clone Inkeep Optional Local Development Services

Source: https://docs.inkeep.com/get-started/traces

Clone the repository containing Docker Compose configuration for running SigNoz and related services locally. This repository provides the necessary setup for local development and testing.

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

--------------------------------

### Initialize New Inkeep Configuration (`inkeep init`)

Source: https://docs.inkeep.com/typescript-sdk/cli-reference

Demonstrates how to initialize a new Inkeep configuration file using the `inkeep init` command. Supports interactive and non-interactive modes, and specifying a template configuration file.

```bash
# Interactive initialization
inkeep init

# Initialize in specific directory
inkeep init ./my-project

# Non-interactive mode
inkeep init --no-interactive

# Use specific config as template
inkeep init --config ./template-config.ts
```

--------------------------------

### Agent Generation Span Example

Source: https://docs.inkeep.com/community/contributing/spans

Shows an example of creating an 'agent.generate' span within an Agent class, including relevant attributes like `agent.id` and `agent.name`. This demonstrates span usage in a specific class method.

```typescript
// Class: Agent
// Function: generate
return tracer.startActiveSpan(
  "agent.generate",
  {
    attributes: {
      "agent.id": this.id,
      "agent.name": this.name,
    },
  },
  async (span: Span) => {
    // ... implementation
  }
);
```

--------------------------------

### Configure Nango Credentials and Restart Docker

Source: https://docs.inkeep.com/community/contributing/overview

Sets up the Nango credential store by creating a `.env` file with an auto-generated encryption key, restarting Docker containers, and configuring Nango API key environment variables in multiple agent API service `.env` files.

```bash
cd deploy/docker
cp .env.nango.example .env
encryption_key=$(openssl rand -base64 32)
sed -i '' "s|REPLACE_WITH_BASE64_256BIT_ENCRYPTION_KEY|$encryption_key|" .env
docker compose up -d

cd ../../
printf "Enter your Nango API key: " && read key && sed -i '' "s|^NANGO_SECRET_KEY=.*|NANGO_SECRET_KEY=$key|" agents-manage-api/.env agents-run-api/.env agents-manage-ui/.env
```

--------------------------------

### List Available MCP Templates with Inkeep CLI

Source: https://docs.inkeep.com/typescript-sdk/project-management

Run this command without arguments to list all available project and MCP server templates from the Inkeep Agents Cookbook. This helps you discover templates you can add to your workspace.

```bash
inkeep add
```

--------------------------------

### Update packages and install Git and Docker

Source: https://docs.inkeep.com/self-hosting/aws-ec2

Install essential packages on the EC2 instance including system updates, git for repository cloning, and Docker for containerization. These are prerequisites for running Docker Compose and deploying containerized services.

```bash
sudo dnf update
sudo dnf install -y git
sudo dnf install -y docker
```

--------------------------------

### Clone and Set Up Inkeep External Services with Docker

Source: https://docs.inkeep.com/self-hosting/docker-local

Clones the repository containing Docker configurations for SigNoz and Nango, and generates a local .env file with a secure encryption key. This sets up the necessary external services for the Inkeep Agent Framework.

```bash
git clone https://github.com/inkeep/agents-optional-local-dev inkeep-external-services
cd inkeep-external-services
cp .env.example .env && \
  encryption_key=$(openssl rand -base64 32) && \
  tmp_file=$(mktemp) && \
  sed "s|<REPLACE_WITH_BASE64_256BIT_ENCRYPTION_KEY>|$encryption_key|" .env > "$tmp_file" && \
  mv "$tmp_file" .env && \
  echo "Docker environment file created with auto-generated encryption key"
```

--------------------------------

### Create Agents with TypeScript SDK

Source: https://docs.inkeep.com/overview

Demonstrates creating a sub-agent and basic agent using Inkeep's TypeScript SDK. The example defines a hello-agent that logs console messages and a basic-agent that uses it as the default sub-agent. Requires the @inkeep/agents-sdk package and MCP tools integration.

```typescript
import { agent, subAgent } from "@inkeep/agents-sdk";
import { consoleMcp } from "./mcp";

const helloAgent = subAgent({
  id: "hello-agent",
  name: "Hello Agent",
  description: "Says hello",
  canUse: () => [consoleMcp],
  prompt: `Reply to the user and console log "hello world" with fun variations like h3llo world`,
});

export const basicAgent = agent({
  id: "basic-agent",
  name: "Basic Agent",
  description: "A basic agent",
  defaultSubAgent: helloAgent,
  subAgents: () => [helloAgent],
});
```

--------------------------------

### Install Docker Compose plugin

Source: https://docs.inkeep.com/self-hosting/aws-ec2

Download and install Docker Compose as a Docker CLI plugin by creating the necessary directory structure and downloading the latest release binary. Sets executable permissions to enable docker compose commands.

```bash
sudo mkdir -p /usr/libexec/docker/cli-plugins
sudo curl -SL https://github.com/docker/compose/releases/latest/download/docker-compose-linux-$(uname -m) -o /usr/libexec/docker/cli-plugins/docker-compose
sudo chmod +x /usr/libexec/docker/cli-plugins/docker-compose
```

--------------------------------

### Push Project to Inkeep Server (`inkeep push`)

Source: https://docs.inkeep.com/typescript-sdk/cli-reference

Shows how to push a project containing Agent configurations to the Inkeep server using the `inkeep push` command. Covers various options like specifying project ID, environment, overriding config paths, and generating JSON output.

```bash
# Push project from current directory
inkeep push

# Push specific project directory
inkeep push --project ./my-project

# Push with development environment credentials
inkeep push --env development

# Generate project JSON without pushing
inkeep push --json

# Override tenant ID
inkeep push --tenant-id my-tenant

# Override API URLs
inkeep push --agents-manage-api-url https://api.example.com
inkeep push --agents-run-api-url https://run.example.com

# Use specific config file
inkeep push --config ./custom-config/inkeep.config.ts
```

--------------------------------

### Push Project to Visual Builder using Inkeep CLI

Source: https://docs.inkeep.com/community/contributing/overview

Installs the Inkeep CLI globally and pushes a local project to the Inkeep Visual Builder. This enables a code-to-visual workflow, allowing development in both programmatic and drag-and-drop interfaces.

```bash
pnpm install -g @inkeep/agents-cli
cd agents-cookbook/template-projects/weather-project
inkeep push
```

--------------------------------

### Custom Status Component Data Structure Example

Source: https://docs.inkeep.com/typescript-sdk/structured-outputs/status-updates

An example JSON structure for a custom status component, illustrating the 'type', 'label', and 'details' fields. This format is used for providing specific, structured information about operations, such as tool names, purposes, and outcomes, within status updates.

```json
{
  "type": "tool_summary",
  "label": "Search completed successfully",
  "details": {
    "tool_name": "search_knowledge_base",
    "purpose": "Find API authentication documentation",
    "outcome": "Found 5 relevant articles with code examples"
  }
}
```

--------------------------------

### Git Hooks for Code Quality (Husky)

Source: https://docs.inkeep.com/community/contributing/overview

This section describes the use of Husky for Git hooks in the Inkeep project. The pre-commit hook automatically runs type checking and tests to ensure code quality before allowing a commit. Hooks are installed via `pnpm install`.

```bash
# Git hooks are automatically installed via:
pnpm install

# The pre-commit hook performs the following checks:
# 1. Type checking
# 2. Runs the test suite
```
Tokens:
Raw