Compare commits

...
7 Commits
Author SHA1 Message Date
MervinPraison f10936de79 Release v0.2.37 2026-08-14 14:16:18 +00:00
Mervin Praison 49b717ecfe Merge pull request #78 from MervinPraison/claude/issue-3937-20260814
feat: optional tool-registry proxy connector
2026-08-14 15:15:24 +01:00
MervinPraisonandMervin Praison 6acddaaa95 fix(registry-proxy): bind token to trusted config, persist session spend, fail-closed budget
Addresses reviewer findings on PR #78:
- Do not attach the ambient TOOL_PROXY_TOKEN when an explicit proxy_url is
  supplied without a matching token, preventing token exfiltration to an
  attacker-controlled endpoint (Critical).
- Persist cumulative spend per (proxy_url, token) via a module-level store so
  max_session_spend enforces across separate registry_call invocations (Major).
- Fail closed in _check_budget when a guard is configured but price cannot be
  validated; record spend deterministically from the quoted price (Major).
- Add regression tests + autouse spend-state reset fixture; update docs.

Co-authored-by: Mervin Praison <[email protected]>
2026-08-14 14:05:23 +00:00
MervinPraisonandMervinPraison ed07dfc6a5 feat: optional tool-registry proxy connector (fixes MervinPraison/PraisonAI#3937)
Add a bring-your-own-account connector mirroring PraisonAI's deferred
tool-search bridge: registry_search / registry_describe / registry_call
over a registry's plain-HTTP proxy (token header, configurable base URL).
Credentials are injected server-side by the registry, never held by the
agent. Connector is disabled unless TOOL_PROXY_URL is set; httpx is
lazy-imported; errors surface as {"error": ...} tool results. Includes
optional per-call/per-session spend guards, docs (Tiers 0/1/2) and mocked
HTTP unit tests plus a skills-dir compatibility test.

Co-authored-by: MervinPraison <[email protected]>
2026-08-14 13:45:49 +00:00
MervinPraison 8e1fe1d860 Release v0.2.36 2026-08-04 11:41:31 +00:00
praisonai-triage-agent[bot] 0629d18a4e Merge pull request #75 from MervinPraison/claude/issue-74-20260804-0919
feat: add tool discovery/catalogue contract
2026-08-04 11:40:29 +00:00
MervinPraisonandMervin Praison 1950368530 feat: add tool discovery/catalogue contract (fixes #74)
Expose a programmatic catalogue of shipped tools plus a `praisonai.tools`
entry-point discovery contract so validators/CLI/docs/third-party packages
resolve against the live catalogue instead of a hand-maintained allowlist
that drifts.

- praisonai_tools.catalogue: ToolCatalogueEntry, list_tools(), get_tool_names()
- Derive catalogue from the existing _TOOL_MAP source of truth (no optional deps)
- Discover third-party tools via `praisonai.tools` entry points
- Add `praisonai-tools list [--extras]` CLI subcommand
- Document the entry-point group in pyproject.toml
- Tests in tests/test_catalogue.py

Co-authored-by: Mervin Praison <[email protected]>
2026-08-04 09:24:51 +00:00
11 changed files with 1212 additions and 9 deletions

No files matched your search

+115
View File
@@ -0,0 +1,115 @@
# Tool-Registry Proxy Connector
An **optional, bring-your-own-account** connector that lets any PraisonAI agent
discover and call a large catalogue of third-party API endpoints (SEO,
enrichment, social data, scraping, ads) through a single proxy token — with
**credentials injected server-side by the registry, never held by the agent**.
PraisonAI ships **no registry code, no bundled binary and no default endpoint**.
You supply your own account token or a self-hosted base URL. The connector is
disabled unless `TOOL_PROXY_URL` is configured.
## Overview
The connector mirrors PraisonAI's deferred tool-search bridge
(`tool_search` / `tool_describe` / `tool_call`) with three functions:
| Function | Cost | Purpose |
| --- | --- | --- |
| `registry_search(query)` | free | capability search over the catalogue |
| `registry_describe(tool_id)` | free | params, price-per-call, example response |
| `registry_call(tool_id, params)` | paid | invoke via proxy; credential injected server-side |
## Installation
```bash
pip install "praisonai-tools[registry-proxy]"
```
## Setup (3 lines)
```bash
export TOOL_PROXY_URL="https://your-registry.example.com" # or a self-hosted instance
export TOOL_PROXY_TOKEN="your-proxy-token"
```
```python
from praisonaiagents import Agent
from praisonai_tools.registry_proxy import (
registry_search, registry_describe, registry_call,
)
agent = Agent(
instructions="SEO analyst",
tools=[registry_search, registry_describe, registry_call],
)
agent.start("Find the top backlink sources for example.com and summarise")
# → registry_search("backlinks for a domain") → describe → call
# one token, no vendor keys in the agent
```
## Spend safety
`registry_call` accepts optional budget guards. When a configured budget would
be exceeded, the call is **denied and reported** as a tool-result error (never
raised as an exception):
```python
registry_call(
"seo.backlinks",
{"domain": "example.com"},
max_cost_per_call=0.10, # deny if price-per-call exceeds this
max_session_spend=5.00, # deny if cumulative spend would exceed this
)
```
Per-call price is read from `registry_describe`, so guards work without any
vendor-specific configuration. Guards **fail closed**: if a budget is set but
the price cannot be validated, the call is denied. Cumulative `max_session_spend`
persists across separate `registry_call` invocations within the same process,
scoped per `(proxy_url, token)` so distinct accounts never share a budget.
## Credential safety
The proxy token is only sent to the endpoint it was configured for. If a caller
(or a prompt-injected agent) supplies an explicit `proxy_url` without a matching
`token`, the ambient `TOOL_PROXY_TOKEN` is **not** attached — preventing the
token from being exfiltrated to an untrusted endpoint. For normal use, leave
`proxy_url`/`token` unset and configure `TOOL_PROXY_URL`/`TOOL_PROXY_TOKEN` via
the environment.
## Error taxonomy
All failures are returned as `{"error": ...}` tool results:
- Authentication failed (HTTP 401/403)
- Insufficient balance (HTTP 402)
- Upstream 4xx/5xx passed through
- Request timeout
- `httpx` not installed → install hint
## Tier 0 — Skills directory compatibility (zero code)
Registries that expose `skill install <name>` install skills into
`./.claude/skills/`. PraisonAI **already scans** this directory, so
registry-installed skills are discoverable by PraisonAI agents today with no
additional code:
- `praisonaiagents/skills/discovery.py` — `.claude/skills` compatibility scan
plus an ancestor walk for monorepos.
## Tier 2 — Environment / CLI passthrough (config-only)
A registry's `shell` / `run <vendor> -- args` inject vendor-CLI credentials at
execution time. Using a PraisonAI environment definition, install the registry
CLI and log in via a token env var in `setup:`; the agent's `execute_command`
then has authenticated vendor CLIs (e.g. `run gh -- pr list`) without any key in
the container. Sandbox / board workers inherit the same via the environment
definition.
## Licensing note
Some registries are Apache-2.0 **with additional terms** prohibiting embedding
in commercially distributed products without permission. This connector is
therefore **optional and bring-your-own-account only**: it ships no registry
code and no default endpoint — the same posture as other BYO-account connectors.
+9
View File
@@ -37,6 +37,11 @@ from importlib.metadata import version, PackageNotFoundError
from praisonai_tools.tools.base import BaseTool, ToolResult, ToolValidationError, validate_tool
from praisonai_tools.tools.decorator import tool, FunctionTool, is_tool, get_tool_schema
from praisonai_tools.catalogue import (
ToolCatalogueEntry,
list_tools,
get_tool_names,
)
try:
__version__ = version("praisonai-tools")
@@ -64,6 +69,10 @@ __all__ = [
"FunctionTool",
"is_tool",
"get_tool_schema",
# Tool discovery / catalogue
"ToolCatalogueEntry",
"list_tools",
"get_tool_names",
# Email Tool
"EmailTool",
"send_email",
+166
View File
@@ -0,0 +1,166 @@
"""Tool discovery / catalogue contract for PraisonAI Tools.
This module provides a single, programmatic way to enumerate every tool that
``praisonai-tools`` ships, plus any third-party tool registered via the
``praisonai.tools`` entry-point group. It exists so that the wider SDK (CLI,
docs, YAML validators, third-party packages) can answer *"what tools can I
actually use here?"* against a live catalogue derived from the real registry
rather than a hand-maintained allowlist that drifts.
Usage:
from praisonai_tools import list_tools
for entry in list_tools():
print(entry.name, entry.module, entry.extras, entry.summary)
Third-party packages can register their own tools by declaring an entry point:
# pyproject.toml (third-party tool package)
[project.entry-points."praisonai.tools"]
my_tool = "my_pkg:MyTool"
Nothing here imports optional/heavy dependencies: the catalogue is built from
the module map alone, so ``list_tools()`` is safe to call without any extras
installed.
"""
from __future__ import annotations
from dataclasses import dataclass, field
from typing import Tuple
ENTRY_POINT_GROUP = "praisonai.tools"
# Map from the module (as recorded in ``_TOOL_MAP``) to the optional-dependency
# extras required to use tools defined in it. Modules absent from this mapping
# have no extra requirements (they rely only on the standard library or on the
# base dependencies). Keep this aligned with ``[project.optional-dependencies]``
# in ``pyproject.toml``.
_MODULE_EXTRAS = {
"wordpress_tool": ("wordpress",),
"pinchwork_tool": ("pinchwork", "marketplace"),
"agentid_tool": ("agentid", "marketplace"),
"joy_trust_tool": ("joy-trust", "marketplace"),
"agentfolio_tool": ("agentfolio", "marketplace"),
"praisonai_tools.n8n.n8n_workflow": ("n8n",),
"langextract_tool": ("langextract",),
"swarmscore_tool": ("swarmscore",),
"composio_tool": ("composio",),
}
@dataclass(frozen=True)
class ToolCatalogueEntry:
"""A single discoverable tool.
Attributes:
name: Public name used to import/reference the tool, e.g. ``"QdrantTool"``.
module: Dotted or relative module path that defines the tool.
extras: Optional-dependency extras required to use the tool, e.g.
``("swarmscore",)``. Empty when no extra install is needed.
summary: A one-line human-readable description of the tool.
"""
name: str
module: str
extras: Tuple[str, ...] = field(default_factory=tuple)
summary: str = ""
def _summary_for(name: str) -> str:
"""Derive a concise one-line summary for a tool class name.
We avoid importing the tool (which could pull heavy/optional deps) and
instead produce a stable, human-friendly summary from the name itself.
"""
if name.endswith("Tool"):
base = name[:-4]
else:
base = name
return f"{base} integration tool".strip()
def _first_party_entries() -> "list[ToolCatalogueEntry]":
"""Build catalogue entries for every first-party tool class.
The source of truth is ``praisonai_tools.tools._TOOL_MAP`` which maps every
public name (both classes and helper functions) to its defining module. We
expose only the tool *classes* (names ending in ``Tool``) in the catalogue,
since those are what ``agents.yaml`` and the SDK reference.
"""
from praisonai_tools.tools import _TOOL_MAP
entries = []
for name, module in sorted(_TOOL_MAP.items()):
if not name.endswith("Tool"):
continue
extras = _MODULE_EXTRAS.get(module, ())
entries.append(
ToolCatalogueEntry(
name=name,
module=module,
extras=extras,
summary=_summary_for(name),
)
)
return entries
def _entry_point_entries() -> "list[ToolCatalogueEntry]":
"""Build catalogue entries for third-party tools registered via entry points.
Third-party packages register under the ``praisonai.tools`` entry-point
group. We do not import the target object (to keep discovery cheap and
dependency-free); we record the declared name and module value instead.
"""
try:
from importlib.metadata import entry_points
except ImportError: # pragma: no cover - Python < 3.8
return []
entries = []
try:
eps = entry_points()
# importlib.metadata API differs across versions.
if hasattr(eps, "select"):
selected = eps.select(group=ENTRY_POINT_GROUP)
else: # pragma: no cover - Python < 3.10 dict interface
selected = eps.get(ENTRY_POINT_GROUP, [])
except Exception: # pragma: no cover - defensive
return []
for ep in selected:
entries.append(
ToolCatalogueEntry(
name=ep.name,
module=getattr(ep, "value", "") or "",
extras=(),
summary=f"Third-party tool registered via {ENTRY_POINT_GROUP}",
)
)
return entries
def list_tools() -> "list[ToolCatalogueEntry]":
"""Return the full catalogue of available tools.
Includes every first-party tool shipped with ``praisonai-tools`` plus any
third-party tool registered via the ``praisonai.tools`` entry-point group.
Entries are de-duplicated by name (first-party wins) and returned sorted by
name.
"""
seen = {}
for entry in _first_party_entries():
seen[entry.name] = entry
for entry in _entry_point_entries():
seen.setdefault(entry.name, entry)
return sorted(seen.values(), key=lambda e: e.name)
def get_tool_names() -> "set[str]":
"""Return the set of every available tool name.
Convenience helper for validators that only need membership checks (e.g. to
replace a hand-maintained allowlist).
"""
return {entry.name for entry in list_tools()}
+18 -1
View File
@@ -11,6 +11,7 @@ def main():
print("PraisonAI Developer Tools CLI")
print("\nUsage: praisonai-tools [tool] [args]")
print("\nAvailable tools:")
print(" list List the available tool catalogue")
print(" docs-generate Generate SDK reference documentation")
print(" video AI-powered video editing tools")
print(" fcp Final Cut Pro automation tools")
@@ -19,7 +20,23 @@ def main():
tool = sys.argv[1]
tool_args = sys.argv[2:]
if tool == "docs-generate":
if tool == "list":
parser = argparse.ArgumentParser(prog="praisonai-tools list")
parser.add_argument("--extras", action="store_true",
help="Only show tools that require optional-dependency extras")
args = parser.parse_args(tool_args)
from .catalogue import list_tools
entries = list_tools()
if args.extras:
entries = [e for e in entries if e.extras]
width = max((len(e.name) for e in entries), default=0)
for entry in entries:
extras = f" [extras: {', '.join(entry.extras)}]" if entry.extras else ""
print(f"{entry.name.ljust(width)} {entry.summary}{extras}")
print(f"\n{len(entries)} tools")
return 0
elif tool == "docs-generate":
# Handle docs-generate with its own parser for better help
parser = argparse.ArgumentParser(prog="praisonai-tools docs-generate")
parser.add_argument("--package", choices=["praisonaiagents", "praisonai", "typescript", "all"],
@@ -0,0 +1,43 @@
"""Tool-registry proxy connector for PraisonAI Agents.
Optional bring-your-own-account connector that lets an agent discover and call
a large catalogue of third-party API endpoints through a single proxy token,
with credentials injected server-side by the registry (never held by the agent).
Mirrors PraisonAI's deferred tool-search bridge:
registry_search(query) -> capability search over the catalogue
registry_describe(tool_id) -> params, price-per-call, example response
registry_call(tool_id, ...) -> invoke via proxy (credential injected server-side)
The connector is disabled unless ``TOOL_PROXY_URL`` is configured. PraisonAI
ships no registry code, no bundled binary and no default endpoint - the user
supplies their own account token or self-hosted base URL.
Usage:
from praisonai_tools.registry_proxy import (
registry_search, registry_describe, registry_call,
)
agent = Agent(
instructions="SEO analyst",
tools=[registry_search, registry_describe, registry_call],
)
Environment Variables:
TOOL_PROXY_URL: base URL of the tool registry (unset -> connector disabled)
TOOL_PROXY_TOKEN: proxy token sent as the auth header
"""
from .registry_proxy import (
RegistryProxyTool,
registry_search,
registry_describe,
registry_call,
)
__all__ = [
"RegistryProxyTool",
"registry_search",
"registry_describe",
"registry_call",
]
@@ -0,0 +1,345 @@
"""Tool-registry proxy connector implementation.
Three agent-callable functions over a registry's plain-HTTP surface:
- ``registry_search(query)`` free capability search over the catalogue
- ``registry_describe(tool_id)`` free read: params, price-per-call, example
- ``registry_call(tool_id, ...)``paid invoke through the proxy; the registry
injects the upstream vendor credential server-side.
Design notes:
- ``httpx`` is lazy-imported so the connector adds zero import-time overhead and
no hard dependency when unconfigured.
- The connector is disabled unless ``TOOL_PROXY_URL`` is set.
- Errors (auth / insufficient balance / upstream 4xx / timeout) are returned as
``{"error": ...}`` tool results, never raised as exceptions.
- ``registry_call`` supports optional per-call and per-session spend guards; the
price is read from ``registry_describe`` and the call is denied + reported when
a configured budget would be exceeded.
"""
import os
import logging
from typing import Any, Dict, Optional
from praisonai_tools.tools.base import BaseTool
from praisonai_tools.tools.decorator import tool
logger = logging.getLogger(__name__)
_INSTALL_HINT = "httpx not installed. Install with: pip install 'praisonai-tools[registry-proxy]'"
# Cumulative spend is tracked per (proxy_url, token) so that ``max_session_spend``
# persists across the short-lived connector instances created by the decorated
# functions, without mixing budgets across distinct accounts/endpoints.
_SESSION_SPEND: Dict[tuple, float] = {}
class RegistryProxyTool(BaseTool):
"""Connector for a self-hostable tool registry exposing a plain-HTTP proxy."""
name = "registry_proxy"
description = (
"Discover and call third-party API endpoints through a tool registry "
"proxy; credentials are injected server-side, never held by the agent."
)
def __init__(
self,
proxy_url: Optional[str] = None,
token: Optional[str] = None,
timeout: float = 60.0,
max_cost_per_call: Optional[float] = None,
max_session_spend: Optional[float] = None,
):
url_from_env = proxy_url is None
self.proxy_url = (proxy_url or os.getenv("TOOL_PROXY_URL") or "").rstrip("/")
# Security: only fall back to the environment token when the URL is also
# env-derived (trusted config). An agent-supplied ``proxy_url`` must never
# receive the ambient ``TOOL_PROXY_TOKEN`` - otherwise a prompt-injected
# agent could exfiltrate the token to an attacker-controlled endpoint.
if token is not None:
self.token = token
elif url_from_env:
self.token = os.getenv("TOOL_PROXY_TOKEN")
else:
self.token = None
self.timeout = timeout
self.max_cost_per_call = max_cost_per_call
self.max_session_spend = max_session_spend
super().__init__()
@property
def _spend_key(self) -> tuple:
return (self.proxy_url, self.token)
@property
def _session_spend(self) -> float:
return _SESSION_SPEND.get(self._spend_key, 0.0)
@_session_spend.setter
def _session_spend(self, value: float) -> None:
_SESSION_SPEND[self._spend_key] = value
def run(self, action: str, **kwargs: Any) -> Dict[str, Any]:
"""Dispatch to search/describe/call.
Args:
action: One of ``"search"``, ``"describe"`` or ``"call"``.
**kwargs: Arguments forwarded to the selected operation.
"""
if action == "search":
return self.search(kwargs.get("query", ""))
if action == "describe":
return self.describe(kwargs.get("tool_id", ""))
if action == "call":
return self.call(kwargs.get("tool_id", ""), kwargs.get("params"))
return {"error": f"Unknown action '{action}'. Use search, describe or call."}
def _headers(self) -> Dict[str, str]:
headers = {"Content-Type": "application/json"}
if self.token:
headers["Authorization"] = f"Bearer {self.token}"
return headers
def _require_config(self) -> Optional[Dict[str, Any]]:
if not self.proxy_url:
return {
"error": (
"Tool registry proxy is not configured. Set TOOL_PROXY_URL "
"(and optionally TOOL_PROXY_TOKEN) to enable the connector."
)
}
return None
@staticmethod
def _http_error(exc: Any) -> Dict[str, Any]:
response = getattr(exc, "response", None)
status = getattr(response, "status_code", None)
text = getattr(response, "text", "") if response is not None else str(exc)
if status == 401 or status == 403:
return {"error": f"Authentication failed (HTTP {status}): {text}"}
if status == 402:
return {"error": f"Insufficient balance (HTTP {status}): {text}"}
return {"error": f"HTTP {status}: {text}"}
def search(self, query: str) -> Dict[str, Any]:
"""Search the registry catalogue by capability."""
missing = self._require_config()
if missing:
return missing
if not query:
return {"error": "query is required"}
try:
import httpx
except ImportError:
return {"error": _INSTALL_HINT}
try:
with httpx.Client(timeout=self.timeout) as client:
response = client.get(
f"{self.proxy_url}/catalog/search",
params={"q": query},
headers=self._headers(),
)
response.raise_for_status()
return response.json()
except httpx.TimeoutException:
return {"error": f"Registry search timed out after {self.timeout} seconds"}
except httpx.HTTPStatusError as exc:
return self._http_error(exc)
except Exception as exc: # noqa: BLE001 - surface as tool-result error
logger.error("registry search error: %s", exc)
return {"error": str(exc)}
def describe(self, tool_id: str) -> Dict[str, Any]:
"""Describe one catalogue entry: params, price-per-call, example."""
missing = self._require_config()
if missing:
return missing
if not tool_id:
return {"error": "tool_id is required"}
try:
import httpx
except ImportError:
return {"error": _INSTALL_HINT}
try:
with httpx.Client(timeout=self.timeout) as client:
response = client.get(
f"{self.proxy_url}/catalog/{tool_id}",
headers=self._headers(),
)
response.raise_for_status()
return response.json()
except httpx.TimeoutException:
return {"error": f"Registry describe timed out after {self.timeout} seconds"}
except httpx.HTTPStatusError as exc:
return self._http_error(exc)
except Exception as exc: # noqa: BLE001 - surface as tool-result error
logger.error("registry describe error: %s", exc)
return {"error": str(exc)}
def _check_budget(self, tool_id: str):
"""Deny + report if a configured spend guard would be exceeded.
Returns ``(denial, price)``: ``denial`` is a ``{"error": ...}`` dict when
the call must be rejected (else ``None``); ``price`` is the validated
per-call price when a guard applies (else ``None``).
"""
if self.max_cost_per_call is None and self.max_session_spend is None:
return None, None
described = self.describe(tool_id)
if isinstance(described, dict) and "error" in described:
return described, None
price = described.get("price_per_call") if isinstance(described, dict) else None
try:
price = float(price)
except (TypeError, ValueError):
# Fail closed: a spend guard is configured but the price cannot be
# validated, so we cannot guarantee the budget - deny the call.
return {
"error": (
"Denied: price_per_call is missing or invalid, cannot enforce "
"the configured spend guard."
)
}, None
if self.max_cost_per_call is not None and price > self.max_cost_per_call:
return {
"error": (
f"Denied: price per call {price} exceeds max_cost_per_call "
f"{self.max_cost_per_call}."
)
}, price
if (
self.max_session_spend is not None
and self._session_spend + price > self.max_session_spend
):
return {
"error": (
f"Denied: session spend would reach "
f"{self._session_spend + price}, exceeding max_session_spend "
f"{self.max_session_spend}."
)
}, price
return None, price
def call(self, tool_id: str, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
"""Invoke an endpoint through the proxy (credential injected server-side)."""
missing = self._require_config()
if missing:
return missing
if not tool_id:
return {"error": "tool_id is required"}
denied, quoted_price = self._check_budget(tool_id)
if denied:
return denied
try:
import httpx
except ImportError:
return {"error": _INSTALL_HINT}
try:
with httpx.Client(timeout=self.timeout) as client:
response = client.post(
f"{self.proxy_url}/call/{tool_id}",
json=params or {},
headers=self._headers(),
)
response.raise_for_status()
result = response.json()
except httpx.TimeoutException:
return {"error": f"Registry call timed out after {self.timeout} seconds"}
except httpx.HTTPStatusError as exc:
return self._http_error(exc)
except Exception as exc: # noqa: BLE001 - surface as tool-result error
logger.error("registry call error: %s", exc)
return {"error": str(exc)}
# Record cumulative spend. Prefer the charge reported by the proxy; fall
# back to the price quoted at budget-check time so the session budget
# still accrues when the response omits cost fields.
charged = None
if isinstance(result, dict):
charged = result.get("price_per_call", result.get("cost"))
try:
self._session_spend += float(charged)
except (TypeError, ValueError):
if quoted_price is not None:
self._session_spend += quoted_price
return result
@tool
def registry_search(
query: str,
proxy_url: Optional[str] = None,
token: Optional[str] = None,
) -> Dict[str, Any]:
"""Search the connected tool registry by capability.
Free read. Returns catalogue matches for a natural-language capability query
such as "backlinks for a domain" or "company enrichment by email".
Args:
query: Capability to search for.
proxy_url: Registry base URL (defaults to TOOL_PROXY_URL env var).
token: Proxy token (defaults to TOOL_PROXY_TOKEN env var).
Returns:
Dict with catalogue matches, or ``{"error": ...}`` on failure.
"""
return RegistryProxyTool(proxy_url=proxy_url, token=token).search(query)
@tool
def registry_describe(
tool_id: str,
proxy_url: Optional[str] = None,
token: Optional[str] = None,
) -> Dict[str, Any]:
"""Describe one registry catalogue entry.
Free read. Returns the endpoint's parameters, price-per-call and an example
response so the model can decide whether and how to invoke it.
Args:
tool_id: Catalogue entry identifier (from ``registry_search``).
proxy_url: Registry base URL (defaults to TOOL_PROXY_URL env var).
token: Proxy token (defaults to TOOL_PROXY_TOKEN env var).
Returns:
Dict describing the entry, or ``{"error": ...}`` on failure.
"""
return RegistryProxyTool(proxy_url=proxy_url, token=token).describe(tool_id)
@tool
def registry_call(
tool_id: str,
params: Optional[Dict[str, Any]] = None,
proxy_url: Optional[str] = None,
token: Optional[str] = None,
max_cost_per_call: Optional[float] = None,
max_session_spend: Optional[float] = None,
) -> Dict[str, Any]:
"""Invoke a registry endpoint through the proxy.
Paid call. The registry injects the upstream vendor credential server-side,
so no vendor keys are ever held by the agent. Optional spend guards deny +
report the call when a configured budget would be exceeded.
Args:
tool_id: Catalogue entry identifier (from ``registry_search``).
params: Parameters for the upstream endpoint.
proxy_url: Registry base URL (defaults to TOOL_PROXY_URL env var).
token: Proxy token (defaults to TOOL_PROXY_TOKEN env var).
max_cost_per_call: Deny the call if its price exceeds this value.
max_session_spend: Deny the call if it would push cumulative spend past this value.
Returns:
Dict with the endpoint response, or ``{"error": ...}`` on failure/denial.
"""
return RegistryProxyTool(
proxy_url=proxy_url,
token=token,
max_cost_per_call=max_cost_per_call,
max_session_spend=max_session_spend,
).call(tool_id, params)
+13 -7
View File
@@ -19,10 +19,12 @@ Ready-to-use tools:
from praisonai_tools.tools.base import BaseTool, ToolResult, ToolValidationError, validate_tool
from praisonai_tools.tools.decorator import tool, FunctionTool, is_tool, get_tool_schema
# Lazy imports for tools to avoid loading dependencies until needed
def __getattr__(name):
"""Lazy load tool classes."""
tool_map = {
# Mapping of every public tool name (classes and functions) to the module that
# defines it. This is the single source of truth for lazy loading AND for the
# catalogue/discovery contract (see ``praisonai_tools.catalogue``). Keeping it a
# module-level constant lets other modules enumerate the shipped tools without
# importing any optional dependency.
_TOOL_MAP = {
# Email
"EmailTool": "email_tool",
"send_email": "email_tool",
@@ -559,10 +561,14 @@ def __getattr__(name):
"scan_agent_code": "inkog_tool",
"scan_skill_package": "inkog_tool",
"scan_mcp_server": "inkog_tool",
}
}
if name in tool_map:
module_name = tool_map[name]
# Lazy imports for tools to avoid loading dependencies until needed
def __getattr__(name):
"""Lazy load tool classes."""
if name in _TOOL_MAP:
module_name = _TOOL_MAP[name]
from importlib import import_module
# Handle absolute module paths (e.g., praisonai_tools.n8n.n8n_workflow)
+12 -1
View File
@@ -1,6 +1,6 @@
[project]
name = "praisonai-tools"
version = "0.2.35"
version = "0.2.37"
description = "Extended tools for PraisonAI Agents"
authors = [
{name = "Mervin Praison"}
@@ -27,6 +27,14 @@ dependencies = [
[project.scripts]
praisonai-tools = "praisonai_tools.cli:main"
# Discovery contract for third-party tool packages. They register agent-callable
# tools under the ``praisonai.tools`` entry-point group so that
# ``pip install some-praisonai-tool`` makes them discoverable via
# ``praisonai_tools.list_tools()`` without editing core, e.g.:
#
# [project.entry-points."praisonai.tools"]
# my_tool = "my_pkg:MyTool"
[project.optional-dependencies]
dev = [
@@ -56,6 +64,9 @@ agentfolio = [
n8n = [
"httpx>=0.27.0",
]
registry-proxy = [
"httpx>=0.24.0",
]
langextract = [
"langextract>=0.1.0",
]
+79
View File
@@ -0,0 +1,79 @@
"""Tests for the tool discovery / catalogue contract."""
def test_list_tools_importable_from_top_level():
from praisonai_tools import list_tools, ToolCatalogueEntry, get_tool_names
assert callable(list_tools)
assert callable(get_tool_names)
assert ToolCatalogueEntry is not None
def test_list_tools_returns_entries():
from praisonai_tools import list_tools
from praisonai_tools.catalogue import ToolCatalogueEntry
entries = list_tools()
assert isinstance(entries, list)
assert len(entries) > 100 # ships a large catalogue
assert all(isinstance(e, ToolCatalogueEntry) for e in entries)
def test_entries_only_expose_tool_classes():
from praisonai_tools import list_tools
for entry in list_tools():
assert entry.name.endswith("Tool"), entry.name
def test_entries_are_sorted_and_unique():
from praisonai_tools import list_tools
names = [e.name for e in list_tools()]
assert names == sorted(names)
assert len(names) == len(set(names))
def test_catalogue_derived_from_tool_map_source_of_truth():
from praisonai_tools import list_tools
from praisonai_tools.tools import _TOOL_MAP
expected = {name for name in _TOOL_MAP if name.endswith("Tool")}
actual = {e.name for e in list_tools()}
# Every class in the map must be catalogued (third-party EPs may add more).
assert expected <= actual
def test_previously_missing_optional_tool_is_now_discoverable():
# QdrantTool was a valid tool absent from the wrapper's hand-maintained
# allowlist; it must now be discoverable via the catalogue.
from praisonai_tools import get_tool_names
names = get_tool_names()
assert "QdrantTool" in names
def test_extras_are_populated_for_optional_tools():
from praisonai_tools import list_tools
by_name = {e.name for e in list_tools()}
entries = {e.name: e for e in list_tools()}
assert "SwarmScoreTool" in by_name
assert "swarmscore" in entries["SwarmScoreTool"].extras
def test_entries_have_summary_and_module():
from praisonai_tools import list_tools
for entry in list_tools():
assert entry.module
assert entry.summary
def test_list_tools_does_not_require_optional_deps():
# Building the catalogue must not import any tool module / optional dep.
from praisonai_tools import list_tools
entries = list_tools()
assert entries # smoke: no ImportError raised
+387
View File
@@ -0,0 +1,387 @@
"""Unit tests for the tool-registry proxy connector."""
import os
import pytest
from unittest.mock import Mock, patch, MagicMock
@pytest.fixture(autouse=True)
def reset_session_spend():
"""Isolate cumulative-spend state between tests."""
from praisonai_tools.registry_proxy import registry_proxy as mod
mod._SESSION_SPEND.clear()
yield
mod._SESSION_SPEND.clear()
@pytest.fixture
def mock_httpx():
"""Mock httpx module with proper exception classes."""
mock_module = MagicMock()
mock_module.TimeoutException = type("TimeoutException", (Exception,), {})
class MockHTTPStatusError(Exception):
def __init__(self, message, request=None, response=None):
super().__init__(message)
self.request = request
self.response = response
mock_module.HTTPStatusError = MockHTTPStatusError
with patch.dict("sys.modules", {"httpx": mock_module}):
yield mock_module
class TestConfiguration:
def test_disabled_when_unconfigured(self):
from praisonai_tools.registry_proxy import RegistryProxyTool
with patch.dict(os.environ, {}, clear=True):
tool = RegistryProxyTool()
result = tool.search("backlinks for a domain")
assert "not configured" in result["error"]
def test_reads_env_vars(self):
from praisonai_tools.registry_proxy import RegistryProxyTool
with patch.dict(os.environ, {
"TOOL_PROXY_URL": "https://registry.example.com/",
"TOOL_PROXY_TOKEN": "secret-token",
}):
tool = RegistryProxyTool()
assert tool.proxy_url == "https://registry.example.com"
assert tool.token == "secret-token"
assert tool._headers()["Authorization"] == "Bearer secret-token"
def test_explicit_args_override_env(self):
from praisonai_tools.registry_proxy import RegistryProxyTool
tool = RegistryProxyTool(proxy_url="https://self.host/", token="tok")
assert tool.proxy_url == "https://self.host"
assert tool.token == "tok"
def test_env_token_not_leaked_to_supplied_url(self):
"""Security: an agent-supplied proxy_url must not receive the env token."""
from praisonai_tools.registry_proxy import RegistryProxyTool
with patch.dict(os.environ, {
"TOOL_PROXY_URL": "https://trusted.example.com",
"TOOL_PROXY_TOKEN": "secret-token",
}):
tool = RegistryProxyTool(proxy_url="https://attacker.example.com")
assert tool.proxy_url == "https://attacker.example.com"
assert tool.token is None
assert "Authorization" not in tool._headers()
def test_env_token_used_for_env_url(self):
from praisonai_tools.registry_proxy import RegistryProxyTool
with patch.dict(os.environ, {
"TOOL_PROXY_URL": "https://trusted.example.com",
"TOOL_PROXY_TOKEN": "secret-token",
}):
tool = RegistryProxyTool()
assert tool._headers()["Authorization"] == "Bearer secret-token"
class TestSearch:
def test_search_success(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
response = Mock()
response.json.return_value = {"matches": [{"id": "seo.backlinks"}]}
response.raise_for_status.return_value = None
client = Mock()
client.get.return_value = response
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com", token="t")
result = tool.search("backlinks for a domain")
assert result["matches"][0]["id"] == "seo.backlinks"
client.get.assert_called_once_with(
"https://r.example.com/catalog/search",
params={"q": "backlinks for a domain"},
headers={"Content-Type": "application/json", "Authorization": "Bearer t"},
)
def test_search_requires_query(self):
from praisonai_tools.registry_proxy import RegistryProxyTool
tool = RegistryProxyTool(proxy_url="https://r.example.com")
assert tool.search("")["error"] == "query is required"
class TestDescribe:
def test_describe_success(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
response = Mock()
response.json.return_value = {"id": "seo.backlinks", "price_per_call": 0.01}
response.raise_for_status.return_value = None
client = Mock()
client.get.return_value = response
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com")
result = tool.describe("seo.backlinks")
assert result["price_per_call"] == 0.01
client.get.assert_called_once_with(
"https://r.example.com/catalog/seo.backlinks",
headers={"Content-Type": "application/json"},
)
class TestCall:
def test_call_success(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
response = Mock()
response.json.return_value = {"data": {"backlinks": 42}}
response.raise_for_status.return_value = None
client = Mock()
client.post.return_value = response
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com", token="t")
result = tool.call("seo.backlinks", {"domain": "example.com"})
assert result["data"]["backlinks"] == 42
client.post.assert_called_once_with(
"https://r.example.com/call/seo.backlinks",
json={"domain": "example.com"},
headers={"Content-Type": "application/json", "Authorization": "Bearer t"},
)
def test_call_requires_tool_id(self):
from praisonai_tools.registry_proxy import RegistryProxyTool
tool = RegistryProxyTool(proxy_url="https://r.example.com")
assert tool.call("")["error"] == "tool_id is required"
class TestErrorTaxonomy:
def test_auth_error(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
resp = Mock()
resp.status_code = 401
resp.text = "Unauthorized"
client = Mock()
client.get.side_effect = mock_httpx.HTTPStatusError("401", response=resp)
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com", token="bad")
result = tool.search("x")
assert "Authentication failed" in result["error"]
def test_insufficient_balance_error(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
resp = Mock()
resp.status_code = 402
resp.text = "Payment Required"
client = Mock()
client.post.side_effect = mock_httpx.HTTPStatusError("402", response=resp)
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com")
result = tool.call("seo.backlinks", {})
assert "Insufficient balance" in result["error"]
def test_upstream_4xx_passthrough(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
resp = Mock()
resp.status_code = 404
resp.text = "Not Found"
client = Mock()
client.post.side_effect = mock_httpx.HTTPStatusError("404", response=resp)
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com")
result = tool.call("seo.backlinks", {})
assert "HTTP 404" in result["error"]
def test_timeout_error(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
client = Mock()
client.get.side_effect = mock_httpx.TimeoutException("timed out")
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com", timeout=5.0)
result = tool.search("x")
assert "timed out after 5.0" in result["error"]
def test_missing_httpx(self):
from praisonai_tools.registry_proxy import RegistryProxyTool
tool = RegistryProxyTool(proxy_url="https://r.example.com")
with patch.dict("sys.modules", {"httpx": None}):
with patch("builtins.__import__", side_effect=ImportError("no httpx")):
result = tool.search("x")
assert "httpx not installed" in result["error"]
assert "praisonai-tools[registry-proxy]" in result["error"]
class TestSpendGuards:
def test_max_cost_per_call_denies(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
describe_resp = Mock()
describe_resp.json.return_value = {"id": "seo.backlinks", "price_per_call": 0.50}
describe_resp.raise_for_status.return_value = None
client = Mock()
client.get.return_value = describe_resp
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com", max_cost_per_call=0.10)
result = tool.call("seo.backlinks", {})
assert "exceeds max_cost_per_call" in result["error"]
client.post.assert_not_called()
def test_max_session_spend_denies(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
describe_resp = Mock()
describe_resp.json.return_value = {"price_per_call": 0.60}
describe_resp.raise_for_status.return_value = None
client = Mock()
client.get.return_value = describe_resp
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com", max_session_spend=1.0)
tool._session_spend = 0.50
result = tool.call("seo.backlinks", {})
assert "max_session_spend" in result["error"]
client.post.assert_not_called()
def test_within_budget_allows_and_tracks_spend(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
describe_resp = Mock()
describe_resp.json.return_value = {"price_per_call": 0.05}
describe_resp.raise_for_status.return_value = None
call_resp = Mock()
call_resp.json.return_value = {"data": "ok", "price_per_call": 0.05}
call_resp.raise_for_status.return_value = None
client = Mock()
client.get.return_value = describe_resp
client.post.return_value = call_resp
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com", max_session_spend=1.0)
result = tool.call("seo.backlinks", {})
assert result["data"] == "ok"
assert tool._session_spend == pytest.approx(0.05)
def test_missing_price_fails_closed(self, mock_httpx):
from praisonai_tools.registry_proxy import RegistryProxyTool
describe_resp = Mock()
describe_resp.json.return_value = {"id": "seo.backlinks"}
describe_resp.raise_for_status.return_value = None
client = Mock()
client.get.return_value = describe_resp
mock_httpx.Client.return_value.__enter__.return_value = client
tool = RegistryProxyTool(proxy_url="https://r.example.com", max_cost_per_call=0.10)
result = tool.call("seo.backlinks", {})
assert "cannot enforce" in result["error"]
client.post.assert_not_called()
def test_session_spend_persists_across_registry_call(self, mock_httpx):
"""max_session_spend must accumulate across separate registry_call calls."""
from praisonai_tools.registry_proxy import registry_call
describe_resp = Mock()
describe_resp.json.return_value = {"price_per_call": 0.60}
describe_resp.raise_for_status.return_value = None
call_resp = Mock()
call_resp.json.return_value = {"data": "ok", "price_per_call": 0.60}
call_resp.raise_for_status.return_value = None
client = Mock()
client.get.return_value = describe_resp
client.post.return_value = call_resp
mock_httpx.Client.return_value.__enter__.return_value = client
first = registry_call(
"seo.backlinks", {},
proxy_url="https://r.example.com", token="t",
max_session_spend=1.0,
)
assert first["data"] == "ok"
second = registry_call(
"seo.backlinks", {},
proxy_url="https://r.example.com", token="t",
max_session_spend=1.0,
)
assert "max_session_spend" in second["error"]
class TestDecoratedFunctions:
@patch("praisonai_tools.registry_proxy.registry_proxy.RegistryProxyTool")
def test_registry_search_function(self, mock_cls):
from praisonai_tools.registry_proxy import registry_search
instance = Mock()
instance.search.return_value = {"matches": []}
mock_cls.return_value = instance
registry_search("q", proxy_url="https://r", token="t")
mock_cls.assert_called_once_with(proxy_url="https://r", token="t")
instance.search.assert_called_once_with("q")
@patch("praisonai_tools.registry_proxy.registry_proxy.RegistryProxyTool")
def test_registry_call_function_passes_guards(self, mock_cls):
from praisonai_tools.registry_proxy import registry_call
instance = Mock()
instance.call.return_value = {"data": "ok"}
mock_cls.return_value = instance
registry_call(
"seo.backlinks",
{"domain": "x"},
proxy_url="https://r",
token="t",
max_cost_per_call=0.1,
max_session_spend=1.0,
)
mock_cls.assert_called_once_with(
proxy_url="https://r",
token="t",
max_cost_per_call=0.1,
max_session_spend=1.0,
)
instance.call.assert_called_once_with("seo.backlinks", {"domain": "x"})
def test_smoke_import():
from praisonai_tools.registry_proxy import (
RegistryProxyTool,
registry_search,
registry_describe,
registry_call,
)
assert callable(registry_search)
assert callable(registry_describe)
assert callable(registry_call)
assert RegistryProxyTool().name == "registry_proxy"
@pytest.mark.integration
def test_live_smoke():
"""Gated live smoke test; skipped unless TOOL_PROXY_URL is configured."""
proxy_url = os.getenv("TOOL_PROXY_URL")
if not proxy_url:
pytest.skip("TOOL_PROXY_URL not set")
from praisonai_tools.registry_proxy import registry_search
result = registry_search("backlinks for a domain")
assert isinstance(result, dict)
assert "error" not in result
+25
View File
@@ -0,0 +1,25 @@
"""Tier 0: pin that registry-installed skills (./.claude/skills/) are discoverable.
Registries that expose ``skill install <name>`` install into ``./.claude/skills/``.
PraisonAI's skill discovery already scans that directory, so registry-installed
skills are discoverable with zero connector code. This test pins that contract.
"""
import os
import pytest
def test_claude_skills_dir_is_scanned(tmp_path, monkeypatch):
discovery = pytest.importorskip("praisonaiagents.skills.discovery")
skills_dir = tmp_path / ".claude" / "skills" / "my-registry-skill"
skills_dir.mkdir(parents=True)
monkeypatch.chdir(tmp_path)
dirs = discovery.get_default_skill_dirs()
claude_skills = tmp_path / ".claude" / "skills"
assert any(os.path.samefile(str(d), str(claude_skills)) for d in dirs), (
"PraisonAI must scan ./.claude/skills/ so registry-installed skills are "
"discoverable with zero connector code."
)