Skip to main content

Toolkit for Persona, an agent AI system — provides modular, callable tools for dynamic function execution

Project description

Persona CLI

Persona CLI is a command-line tool for creating and managing projects that use the persona-toolkit — a modular function-calling framework designed for agent-based systems.

This CLI helps you scaffold projects, generate tools, test them locally, and run the FastAPI server that exposes your tools via REST API.


🚀 Installation

To use the CLI, first install the persona-toolkit library (assuming it's published or available locally):

pip install persona-toolkit

Or if you're developing locally:

cd persona-toolkit/
poetry install

The CLI is exposed as:

persona-toolkit

📆 Features

init

Create a new project scaffold with Poetry and the required structure:

persona-toolkit init my-project

This will:

  • Initialize a Poetry project
  • Install persona-toolkit as a dependency
  • Create a tools/ folder where your tools will live

add-tool

Add a new tool interactively:

persona-toolkit add-tool

You'll be prompted for a tool name. A new Python file will be created in the tools/ directory with a ready-to-edit template including:

  • Input and Output models (using Pydantic)
  • A run() function

test-tool

Test a tool locally by manually entering its input values:

persona-toolkit test-tool echo

This will:

  • Import the specified tool from the tools/ directory
  • Prompt for input fields
  • Run the run() function and show the output

You can use the cli to pass input values:

persona-toolkit test-tool echo --input '{"message": "Hello, World!"}'

run

Start the FastAPI server and expose your tools via HTTP:

persona-toolkit run --port 8000

You can now access:

  • GET /tools — list available tools
  • GET /tools/{tool}/schema — get tool schema
  • POST /invocations — run a tool

🗂 Project Structure

my-project/
├── pyproject.toml         # Poetry project config
├── tools/
│   └── echo_test.py            # Example tool

Each tool must define:

  • NAME (a str with tool name)
  • Input (a Pydantic model)
  • Output (a Pydantic model)
  • run(context: AgentContext, input: Input) -> Output

💡 Example Tool

from pydantic import BaseModel, Field
from persona_toolkit.model import AgentContext

NAME = "echo"


class Input(BaseModel):
    message: str = Field(description="Message to echo")


class Output(BaseModel):
    message: str


def run(context: AgentContext, args: Input) -> Output:
    """
    Echo the message back.

    The `context` can be used to store and retrieve state across invocations.
    For example, if a previous message exists in the context, it will be appended to the current message.
    """
    previous_message = context.get("message")
    if previous_message:
        input.message = f"{previous_message} {input.message}"

    context.set("message", args.message)

    return Output(message=f"Echo: {args.message}")

Understanding kwargs and context

The context parameter is an instance of AgentContext, which is a dictionary-like object that provides access to the current execution context of the tool, it includes the following keys:

  • project_id: The ID of the project where the tool is being executed.
  • session_id: The ID of the current session, which can be used to track the state of the conversation or interaction.
  • user_id: The ID of the user invoking the tool, which can be useful for personalizing responses or tracking user-specific data.

And expose a set of methods to manage the context:

  • get(key: str, default: Any = None): Retrieve a value from the context by key. If the key does not exist, return the default value.
  • set(key: str, value: Any): Set a value in the context by key.
  • delete(key: str): Delete a value from the context by key.

For example, if a tool needs to keep track of the last message sent by the user, it can store that message in the context and retrieve it in subsequent invocations, it can be used to:

  • Store intermediate results.
  • Append or modify input values based on previous invocations.
  • Share data across different tools in the same session.

Example of using kwargs

# tools/echo_test.py

from pydantic import BaseModel, Field
from persona_toolkit.model import AgentContext

NAME = "echo"


class Input(BaseModel):
    message: str = Field(description="Message to echo")


class Output(BaseModel):
    message: str


def run(context: AgentContext, args: Input) -> Output:
    """
    Echo the message back.
    """
    # Access primary infos from kwargs
    project_id = context.project_id
    session_id = context.session_id
    user_id = context.user_id

    # TODO: Do something with project_id, session_id, user_id

    return Output(message=f"Echo: {args.message}")

💻 Local Development

To run the CLI locally, you can use the following command:

python persona_toolkit/cli.py --port 8001

You can use local tools folder to test your tools. Just make sure to set the PYTHONPATH to the root of the project:

✅ Requirements

  • Python 3.10+
  • Poetry
  • Uvicorn (installed automatically)

📃 License

MIT License


Built for the Persona Agent System 🤖

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

persona_toolkit-1.0.25.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

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

persona_toolkit-1.0.25-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file persona_toolkit-1.0.25.tar.gz.

File metadata

  • Download URL: persona_toolkit-1.0.25.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.11.4 Linux/6.1.79

File hashes

Hashes for persona_toolkit-1.0.25.tar.gz
Algorithm Hash digest
SHA256 4f00eb7524d7fac3b8363ecfbb7ec94e5652ec561916b9fee3ffe9d09bb44456
MD5 99afbacc079e976ffb09a05b545e5e9b
BLAKE2b-256 7ee7f1c0ff4d38b45a4f5e1a61574679bc589a3e00bd5007d9fe146a7b735904

See more details on using hashes here.

File details

Details for the file persona_toolkit-1.0.25-py3-none-any.whl.

File metadata

  • Download URL: persona_toolkit-1.0.25-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.11.4 Linux/6.1.79

File hashes

Hashes for persona_toolkit-1.0.25-py3-none-any.whl
Algorithm Hash digest
SHA256 4e1495aeaea55679dbd489e5099ddf62e9a06525df30f3d658521f28be3013cd
MD5 4f4d8c6590aef1a44f1efa639279517c
BLAKE2b-256 3ff0f170cc1785a5d7ebd640b824c6065edb716572670af6dbcb8f462245e28d

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