Documentation Index
Fetch the complete documentation index at: https://docs.praison.ai/llms.txt
Use this file to discover all available pages before exploring further.
Add GitHub URL to tools_sources
# TEMPLATE.yaml
name: my-template
version: "1.0.0"
requires:
tools_sources:
- github:MervinPraison/PraisonAI-tools/praisonai_tools/video
Reference Tools in agents.yaml
roles:
agent:
tools:
- shell_tool
tasks:
main:
description: "Use video tools from GitHub"
Run Template
praisonai templates run ./my-template
Get Raw URL
Navigate to the tools.py file on GitHub and click “Raw” to get the raw URL:https://raw.githubusercontent.com/MervinPraison/PraisonAI-tools/main/tools.py
Add to tools_sources
# TEMPLATE.yaml
requires:
tools_sources:
- https://raw.githubusercontent.com/user/repo/main/tools.py
Run Template
praisonai templates run ./my-template
Run with Remote Tool Source
praisonai templates run my-template \
--tools-source github:MervinPraison/PraisonAI-tools/praisonai_tools
Run with Multiple Sources
praisonai templates run my-template \
--tools-source github:user/repo/tools \
--tools-source ./local_tools.py
Install Package
pip install praisonai-tools
Add to tools_sources
# TEMPLATE.yaml
requires:
packages:
- praisonai-tools
tools_sources:
- praisonai_tools.video
Use Tools
praisonai templates run ./my-template
Create Package Structure
my-tools/
├── pyproject.toml
├── my_tools/
│ ├── __init__.py
│ └── tools.py
Define pyproject.toml
[project]
name = "my-tools"
version = "1.0.0"
[project.entry-points."praisonai.tools"]
my_tools = "my_tools:tools"
Publish to PyPI
pip install build twine
python -m build
twine upload dist/*
Use in Templates
requires:
packages:
- my-tools
tools_sources:
- my_tools
| Format | Example |
|---|
| GitHub shorthand | github:user/repo/path |
| GitHub with branch | github:user/repo/path@branch |
| Raw URL | https://raw.githubusercontent.com/... |
| PyPI package | package_name.module |
| Local path | ./tools.py or ./tools_dir/ |
