Skip to main content

A lightweight agent framework

Project description

Lightweight Agent Framework

Lightweight Agent Framework Logo

A minimalist, extensible framework for building autonomous agents with a focus on transparency and composability.

Overview

Lightweight Agent Framework (LAF) provides a simple yet powerful foundation for building autonomous agents that can think, act, and observe within a structured environment. With LAF, you can:

  • Create agents that follow a clear think-act-observe cycle
  • Record and replay agent interactions using the tape system
  • Build complex workflows by composing multiple agents
  • Persist and analyze agent execution history
  • Extend functionality through a modular tool system
  • Integrate with external tools and services using the Model Control Protocol (MCP)

System Architecture

The following diagram illustrates how the components of the Lightweight Agent Framework fit together:

graph TD
    A[Agent] -->|Think| B[LLM]
    A -->|Act| C[MCP Server]
    A -->|Observe| D[Tape System]
    B -->|Generate Thoughts| A
    C -->|Execute Tools| A
    D -->|Record Steps| A
    D -->|Replay History| A

Key Components:

  • Agent: The core entity that performs the think-act-observe cycle.
  • LLM: Large Language Model used by the agent to generate thoughts and reasoning.
  • MCP Server: External server that provides tools and services for the agent to execute actions.
  • Tape System: Records the agent's execution history for analysis, debugging, and replay.

Key Features

  • Simple Core Concepts: Based on three fundamental operations - think, act, and observe
  • Tape-Based History: Record every step of your agent's execution for analysis and debugging
  • Modular Tools: Easily extend agent capabilities through a flexible tool system
  • Built-in Storage: Persist agent history with built-in SQLite support (expandable to other backends)
  • Async Support: Built with asyncio for efficient concurrent operations
  • Testing Ready: Comprehensive testing utilities and fixtures included
  • MCP Integration: Seamlessly integrate with external tools and services using the Model Control Protocol

Quick Installation

pip install robotape

For development installation:

pip install robotape[dev]

Basic Usage

Here's a simple example of creating and running an agent:

from robotape.agents import SimpleAgent
from robotape.tape import Tape, StepType

# Create an agent and a tape
agent = SimpleAgent("my_agent")
tape = Tape()

# Add an initial thought
tape.append(Step(
    type=StepType.THOUGHT,
    content="I should search for information",
    metadata=StepMetadata(agent="my_agent", node="planning")
))

# Execute the agent
await agent.execute_step(tape.get_last_step())

Using MCPLLMAgent

The MCPLLMAgent is a specialized agent that combines the capabilities of LLMs with the Model Control Protocol (MCP). It allows agents to interact with external tools and services through an MCP server, enabling more complex workflows and integrations.

Example: Using MCPLLMAgent

from robotape.agents.mcpllm import MCPLLMAgent
from robotape.llm import LLMConfig

# Configure the LLM
llm_config = LLMConfig(
    model="gpt-4",
    api_key="your-api-key",
    provider_name="openai"
)

# Configure the MCP server
mcp_config = {
    "command": "python",
    "args": ["path/to/mcp_server.py"],
    "env": {"ENV_VAR": "value"}
}

# Create an MCPLLMAgent
agent = MCPLLMAgent("mcp_agent", llm_config, mcp_config)

# Connect to the MCP server
await agent.connect()

# Execute a full think-act-observe cycle
context = {"task": "Analyze test data"}
thought_result = await agent.think(context)
action_result = await agent.act(thought_result)
observe_result = await agent.observe(action_result)

Advanced Features

  • Custom Agents: Extend BaseAgent to create specialized agents
  • Tool Integration: Add new capabilities through the tool system
  • Storage Backends: Built-in SQLite support, extensible to other databases
  • Tape Management: Clone, branch, and analyze execution history
  • Validation: Built-in parameter validation and error handling
  • MCP Integration: Connect to external tools and services using the Model Control Protocol

Documentation

The framework provides comprehensive documentation covering all aspects:

  1. Getting Started Guide: Quick start guide and core concepts
  2. API Reference: Complete reference of all public APIs
  3. Advanced Patterns: Advanced usage patterns and best practices
  4. Agent System: Guide to creating and managing agents
  5. LLM Integration: Integrating Large Language Models
  6. MCP (Master Control Program): Understanding the MCP component
  7. MCP Tools: Available MCP tools and utilities
  8. Tape System: Recording and analyzing agent execution
  9. Tools: Using and creating agent tools

Development

Clone and set up the development environment:

git clone https://github.com/andrewlwn77/robotape.git
cd robotape
pip install -e ".[dev]"

Run tests:

pytest tests/ --cov=robotape

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robotape-0.6.0.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

robotape-0.6.0-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

Details for the file robotape-0.6.0.tar.gz.

File metadata

  • Download URL: robotape-0.6.0.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.10.11 Windows/10

File hashes

Hashes for robotape-0.6.0.tar.gz
Algorithm Hash digest
SHA256 ad738c739b35dd55dcfd098cea776960905d9199a76ef0dbf90aa625a2a70c53
MD5 d9c99798f5f9f1e0a67efabdd675bc08
BLAKE2b-256 35952269cb81668fc27e70a0e31e3768d77123ac591af0010a97124c3767cd9c

See more details on using hashes here.

File details

Details for the file robotape-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: robotape-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 27.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.10.11 Windows/10

File hashes

Hashes for robotape-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eaf914d6a5d45b0249c530b5b911e01b0d6896590a3ce9fa0a447b5d0d9937a6
MD5 edcf2a58451046a56dcf8e30287d4cca
BLAKE2b-256 299883aee6c0b4d746914c067230841af6c3f891e60ce737c081dbb32b23dd9c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page