Digital Employee Core
A Python library for building and managing AI-powered digital employees with support for tools, MCPs (Model Context Protocol), and flexible configuration management.
Setup
1. Install Dependencies
poetry install
2. Configure Environment
Copy the example environment file and add your credentials:
cp .env.example .env
Edit .env with your configuration:
# Required
AIP_API_URL=https://your-ai-platform-url.com
AIP_API_KEY=your-api-key
Tool-Specific Requirements
E2B Sandbox Tool
This tool requires an api_key parameter to be provided. You can either:
- Pass the API key directly as a parameter when using the tool, or
- Set the
E2B_API_KEYenvironment variable (the tool will use this automatically if no parameter is provided)
Hybrid Vector Retrieval Tool
This tool requires AWS credentials to be configured in the AIP environment where the digital employee is deployed.
Configuration Management
Understanding MCP Configuration Placeholders
The library uses YAML configuration templates (digital_employee_core/config_templates/mcp_configs.yaml and tool_configs.yaml) that contain placeholder keys in dollar-brace format (e.g., ${GOOGLE_CALENDAR_MCP_URL}). These placeholders need to be replaced with actual values at runtime.
How Placeholders Work:
- Configuration Template (in
mcp_configs.yaml):
digital_employee_google_calendar_mcp:
config:
url: ${GOOGLE_CALENDAR_MCP_URL}
allowed_tools: ${GOOGLE_CALENDAR_MCP_ALLOWED_TOOLS:[]}
authentication:
type: api-key
key: X-API-Key
value: ${GOOGLE_MCP_X_API_KEY}
- Supply Values using
DigitalEmployeeConfiguration:
from digital_employee_core import DigitalEmployeeConfiguration
configurations = [
DigitalEmployeeConfiguration(
key="GOOGLE_CALENDAR_MCP_URL",
value="https://api.example.com/calendar/mcp"
),
DigitalEmployeeConfiguration(
key="GOOGLE_MCP_X_API_KEY",
value="your-secret-api-key"
),
]
- Pass to Digital Employee:
from digital_employee_core import DigitalEmployee
from digital_employee_core.connectors.mcps import google_calendar_mcp
de = DigitalEmployee(
identity=identity,
mcps=[google_calendar_mcp],
configurations=configurations # Placeholder values will be replaced automatically
)
de.deploy()
Available Placeholder Keys
Refer to digital_employee_core/config_templates/mcp_configs.yaml and tool_configs.yaml to see all available placeholders. Common ones include:
Google MCPs:
GOOGLE_CALENDAR_MCP_URLGOOGLE_CALENDAR_MCP_ALLOWED_TOOLSGOOGLE_DOCS_MCP_URLGOOGLE_DOCS_MCP_ALLOWED_TOOLSGOOGLE_DRIVE_MCP_URLGOOGLE_DRIVE_MCP_ALLOWED_TOOLSGOOGLE_MAIL_MCP_URLGOOGLE_MAIL_MCP_ALLOWED_TOOLSGOOGLE_SHEETS_MCP_URLGOOGLE_SHEETS_MCP_ALLOWED_TOOLSGOOGLE_MCP_X_API_KEY
GitHub MCP:
GITHUB_MCP_URLGITHUB_MCP_X_API_KEY
SQL Tool MCP:
SQL_TOOL_MCP_URLSQL_AUTH_TOKENSQL_API_KEYSQL_IDENTIFIER
Configuration Priority
Configurations can be supplied in three ways:
- At Initialization (applied during
deploy()):
de = DigitalEmployee(
identity=identity,
mcps=[google_calendar_mcp],
configurations=configurations
)
- At Runtime (applied per
run()call):
response = de.run(
message="Check my calendar",
configurations=runtime_configurations
)
- Combined (initialization configs + runtime configs are merged):
# Initialization configs for persistent settings
de = DigitalEmployee(
identity=identity,
configurations=base_configurations
)
de.deploy()
# Runtime configs for per-request overrides
response = de.run(
message="Send email",
configurations=request_specific_configurations
)
Run Examples
Basic Usage
poetry run python examples/basic_usage.py
Configuration Usage
poetry run python examples/configuration_usage.py
Subclass Example
poetry run python examples/subclass_example.py
Run Tests
# Run all tests
poetry run pytest
# Run with verbose output
poetry run pytest -v
# Run with coverage
poetry run coverage run -m pytest
poetry run coverage report
# Run with coverage HTML report
poetry run coverage run -m pytest
poetry run coverage html
# Open htmlcov/index.html in browser
# Run specific test file
poetry run pytest tests/digital_employee/test_digital_employee.py
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file digital_employee_core-0.0.37.tar.gz.
File metadata
- Download URL: digital_employee_core-0.0.37.tar.gz
- Upload date:
- Size: 55.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.2.1 CPython/3.12.3 Linux/6.14.0-1011-aws
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d61747c0be36372938dcce9d7845196c891d33cf5c8be3501320d6126cfde453
|
|
| MD5 |
6399619588e7971dc7e37368d9ffd342
|
|
| BLAKE2b-256 |
b1d2f639ec05497b6ba73affef64fac7560c820d922edc865e529bf7d9749c16
|
File details
Details for the file digital_employee_core-0.0.37-py3-none-any.whl.
File metadata
- Download URL: digital_employee_core-0.0.37-py3-none-any.whl
- Upload date:
- Size: 80.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.2.1 CPython/3.12.3 Linux/6.14.0-1011-aws
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a48f09f4f9cf4d8c5712c9dd9c051a7e56da9eb6dcbee82b50275834690fde4
|
|
| MD5 |
ef1bb129cf83890e5715311cb125ce53
|
|
| BLAKE2b-256 |
4519abd9970f25f008b7b0484d55217ed80731742b010e89250c2cf9a29ed351
|
