# 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
- A Siren API key (get one from [Siren Dashboard](https://app.trysiren.io/configuration))
## Installation
```bash
pip install siren-agent-toolkit
```
For local development:
```bash
# From the python/ directory
pip install -e .
```
## Usage
### Basic Example
```python
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:
```python
from siren_agent_toolkit.api import SirenAPI
api = SirenAPI(
api_key="YOUR_API_KEY",
context={"env": "production"} # Optional environment configuration
)
```
### Building Locally
```bash
# From the python/ directory
pip install -e .
# Install development dependencies
pip install -r requirements.txt
```
### Running Tests
```bash
pytest tests/
```
## License
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "siren-agent-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "agent, ai, crewai, langchain, notifications, openai, siren, toolkit",
"author": null,
"author_email": "Siren <support@trysiren.io>",
"download_url": "https://files.pythonhosted.org/packages/ba/ee/0feaad09db673196cb4b47345b5643b3b3405d9cec05cfd0943e635fdb50/siren_agent_toolkit-0.1.1.tar.gz",
"platform": null,
"description": "# Siren Agent Toolkit (Python)\n\nThe **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.\n\n## Features & Capabilities\n\n### Messaging\n- Send messages via various channels (Email, SMS, WhatsApp, Slack, Teams, Discord, Line, etc.)\n- Retrieve message status and replies\n- Support for template-based and direct messaging\n\n### Templates\n- List, create, update, delete, and publish notification templates\n- Create and manage channel-specific templates\n- Support for template variables and versioning\n\n### Users\n- Add, update, and delete users\n- Manage user attributes and contact information\n\n### Workflows\n- Trigger workflows (single or bulk operations)\n- Schedule workflows for future or recurring execution\n- Pass custom data to workflow executions\n\n### Webhooks\n- Configure webhooks for status updates\n- Set up inbound message webhooks\n- Optional webhook verification with secrets\n\n## \ud83d\udccb Requirements\n\n- A Siren API key (get one from [Siren Dashboard](https://app.trysiren.io/configuration))\n\n## Installation\n\n```bash\npip install siren-agent-toolkit\n```\n\nFor local development:\n\n```bash\n# From the python/ directory\npip install -e .\n```\n\n## Usage\n\n### Basic Example\n\n```python\nfrom siren_agent_toolkit.api import SirenAPI\n\n# Initialize with your API key\napi = SirenAPI(api_key=\"YOUR_API_KEY\")\n\n# Send a simple email message\nresult = api.run(\"send_message\", {\n \"recipient_value\": \"user@example.com\",\n \"channel\": \"EMAIL\",\n \"subject\": \"Important Update\",\n \"body\": \"Hello from Siren! This is an important notification.\"\n})\nprint(result)\n```\n\n## Examples\n\nComplete working examples are available in the `examples/` directory:\n\n- `examples/langchain/main.py` \u2014 Using Siren tools with LangChain\n- `examples/openai/main.py` \u2014 Using Siren tools with OpenAI\n- `examples/crewai/main.py` \u2014 Using Siren tools with CrewAI\n\n## Development\n\n### Configuration\n\nThe toolkit supports flexible configuration options:\n\n```python\nfrom siren_agent_toolkit.api import SirenAPI\n\napi = SirenAPI(\n api_key=\"YOUR_API_KEY\",\n context={\"env\": \"production\"} # Optional environment configuration\n)\n```\n\n### Building Locally\n\n```bash\n# From the python/ directory\npip install -e .\n# Install development dependencies\npip install -r requirements.txt\n```\n\n### Running Tests\n\n```bash\npytest tests/\n```\n## License\n\nMIT",
"bugtrack_url": null,
"license": "MIT",
"summary": "Agent toolkit for Siren notification platform",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/KeyValueSoftwareSystems/siren-agent-toolkit/issues",
"Documentation": "https://docs.trysiren.io",
"Homepage": "https://github.com/KeyValueSoftwareSystems/siren-agent-toolkit",
"Repository": "https://github.com/KeyValueSoftwareSystems/siren-agent-toolkit.git"
},
"split_keywords": [
"agent",
" ai",
" crewai",
" langchain",
" notifications",
" openai",
" siren",
" toolkit"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dab152e0efd587e7c5808de9303b2d53a391e3d89da25513cbcd399f2229f4f2",
"md5": "f6c2cdb0a4fc974927059bb1216392ae",
"sha256": "0a7635e58a25e71156b8849a7074191dc4a3097f6fc40cbf92e7a6e319de486c"
},
"downloads": -1,
"filename": "siren_agent_toolkit-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f6c2cdb0a4fc974927059bb1216392ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12331,
"upload_time": "2025-08-24T11:53:24",
"upload_time_iso_8601": "2025-08-24T11:53:24.342246Z",
"url": "https://files.pythonhosted.org/packages/da/b1/52e0efd587e7c5808de9303b2d53a391e3d89da25513cbcd399f2229f4f2/siren_agent_toolkit-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "baee0feaad09db673196cb4b47345b5643b3b3405d9cec05cfd0943e635fdb50",
"md5": "44f3be86b10cbf7f1d1843c3235d28b0",
"sha256": "d23b6823c224c77a77dce27e01956bfcbbfda1f6626cad486be90ae276712249"
},
"downloads": -1,
"filename": "siren_agent_toolkit-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "44f3be86b10cbf7f1d1843c3235d28b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11166,
"upload_time": "2025-08-24T11:53:25",
"upload_time_iso_8601": "2025-08-24T11:53:25.425246Z",
"url": "https://files.pythonhosted.org/packages/ba/ee/0feaad09db673196cb4b47345b5643b3b3405d9cec05cfd0943e635fdb50/siren_agent_toolkit-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-24 11:53:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "KeyValueSoftwareSystems",
"github_project": "siren-agent-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "siren-agent-toolkit"
}
JSON
