Skip to main content

Agent toolkit for Siren notification platform

Project description

Siren Agent Toolkit (Python)

The Siren Agent Toolkit provides a unified Python interface and agent tools for interacting with the Siren MCP (Model Context Protocol) platform. It enables messaging, template management, user management, workflow automation, and webhook configuration, with seamless integration into popular agent frameworks like LangChain, OpenAI, and CrewAI.

Features & Capabilities

Messaging

  • Send messages via various channels (Email, SMS, WhatsApp, Slack, Teams, Discord, Line, etc.)
  • Retrieve message status and replies
  • Support for template-based and direct messaging

Templates

  • List, create, update, delete, and publish notification templates
  • Create and manage channel-specific templates
  • Support for template variables and versioning

Users

  • Add, update, and delete users
  • Manage user attributes and contact information

Workflows

  • Trigger workflows (single or bulk operations)
  • Schedule workflows for future or recurring execution
  • Pass custom data to workflow executions

Webhooks

  • Configure webhooks for status updates
  • Set up inbound message webhooks
  • Optional webhook verification with secrets

📋 Requirements

Installation

pip install siren-agent-toolkit

For local development:

# From the python/ directory
pip install -e .

Usage

Basic Example

from siren_agent_toolkit.api import SirenAPI

# Initialize with your API key
api = SirenAPI(api_key="YOUR_API_KEY")

# Send a simple email message
result = api.run("send_message", {
    "recipient_value": "user@example.com",
    "channel": "EMAIL",
    "subject": "Important Update",
    "body": "Hello from Siren! This is an important notification."
})
print(result)

Examples

Complete working examples are available in the examples/ directory:

  • examples/langchain/main.py — Using Siren tools with LangChain
  • examples/openai/main.py — Using Siren tools with OpenAI
  • examples/crewai/main.py — Using Siren tools with CrewAI

Development

Configuration

The toolkit supports flexible configuration options:

from siren_agent_toolkit.api import SirenAPI

api = SirenAPI(
    api_key="YOUR_API_KEY",
    context={"env": "production"}  # Optional environment configuration
)

Building Locally

# From the python/ directory
pip install -e .
# Install development dependencies
pip install -r requirements.txt

Running Tests

pytest tests/

License

MIT

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

siren_agent_toolkit-0.1.0.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

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

siren_agent_toolkit-0.1.0-py3-none-any.whl (2.6 kB view details)

Uploaded Python 3

File details

Details for the file siren_agent_toolkit-0.1.0.tar.gz.

File metadata

  • Download URL: siren_agent_toolkit-0.1.0.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for siren_agent_toolkit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 04d751b8fca40b4661b33d8362c352d2f764c5b5ab721e6a923329699f64110c
MD5 bc9b86089b7e0f74820de84d1e497ba1
BLAKE2b-256 db7ecd4efb9667f0781d111c666b50450b2be45cd38eba4d1cebc74c1cadb189

See more details on using hashes here.

File details

Details for the file siren_agent_toolkit-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for siren_agent_toolkit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d31f3b4b695a489d94cb76146719d3e10b07107f513c3c442e496a2fa4c8427
MD5 b5c6c18040a3d783cc3977903612ab0e
BLAKE2b-256 7c7e6878d54c74f5cfe8b8858125a0f48e9d559fa2d1c72883d5d2a8880b9112

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