Skip to content

README.md

Latest commit

 

History

History
65 lines (53 loc) · 3.56 KB

README.md

File metadata and controls

65 lines (53 loc) · 3.56 KB
Raw

toolpass documentation

These pages cover toolpass's permission checks: the engine behind Toolpass, guarded and permission_check. For the secure-tools toolkit (scope limits, the untrusted-input and exfiltration guards, credential injection), see the package README.

toolpass answers one question before your agent acts for someone: may this user do this action on this resource in this system? It asks the system itself, live, and answers allow, deny or unknown. It is a Python package: the engine runs in your agent's process, or as a server that agents in any language call.

Get started

  • Permission checks: what they do, how they differ from policy engines and OAuth, and its security model.
  • Quickstart: install toolpass, ask a question, guard an agent tool, and run it as a server, in five minutes.

Concepts

  • Architecture: the parts, how one check flows, what is cached, and the trust boundaries.

Guides

  • Deploy: in-process, sidecar or shared service, TLS, Docker, pip, Kubernetes with Helm, scaling and a production checklist.
  • Add toolpass to your agent: which tools to guard, where the user comes from, and the adapters for Strands, LangChain and LangGraph, the OpenAI Agents SDK, the Claude Agent SDK, Google ADK, CrewAI, Pydantic AI, LlamaIndex and the Vercel AI SDK.
  • Check what a tool does, not what it says: the requests a tool's body makes, mapped to actions and checked before they are sent; as_user() and as_agent(); recording a tool's entitlements and holding it to them.
  • Groups from the user's token: the systems that grant by group, the groups field, and the oidc_* keys that read the groups from the user's own ID token, with any provider.
  • Operating: health, the decision log, what each unknown means, and rotating secrets.
  • The dashboard: every run of your toolpass tools, from every agent and MCP server that reports to your toolpass server, with each request it made and who it ran for; and the OpenTelemetry export.

Reference

  • Python API: Toolpass in-process and remote, check, require, guarded, the framework adapters, and the Node client.
  • The toolkit's observed actions: the permissions, entitlements, record, strict and act_as settings, as_user() and as_agent(), ActionRefused, ObservedAction, the entitlements file and the route tables.
  • HTTP API: POST /check, every decision code, fresh checks, GET /healthz, POST /runs and GET /dashboard/.
  • Configuration: toolpass.yaml, top-level and per-connection keys, and the same connections given in code.
  • Command line: serve, validate, probe, check, catalog, routes, and gateway off.
  • Integrations: the twenty-two systems, their status, and one page each.
  • Packages and releases: toolpass, the Node client, the image and the chart, and how they are released.
  • Helm chart values.

Development