Skip to content

README.md

Latest commit

 

History

History
83 lines (62 loc) · 3.86 KB

README.md

File metadata and controls

83 lines (62 loc) · 3.86 KB
Raw

Factorly Documentation

What You Get

  • One endpoint — your agent connects to Factorly, sees everything
  • Credentials secured — secrets live in the encrypted vault or env vars, never in the agent
  • Every call logged — every tool call is logged with timestamp, parameters, and response summary
  • Zero lock-in — your tools don't change. Remove Factorly and everything still works independently
  • Any protocol — MCP servers, REST APIs, CLI tools. One config format for all of them
  • Zero-config proxy — factorly wrap adds safety to any MCP server with no config file needed
Type How It Works
CLI commands Define command + args in YAML. {{param}} placeholders substituted.
REST APIs Define base URL, method, path, auth, parameters. HTTP calls with routing.
MCP servers Spawn child servers (stdio) or connect to remote (HTTP). Tools discovered automatically.
Output processing Compression (JSON compact, log dedup, ANSI strip) + truncation with head/tail split.
Oversight Deny, confirm, rate limit, loop detection. Per-tool shadow policy.
Built-in tools Governed shell, file read/write, fetch, clipboard — with default safety guards.

Getting Started

Topic Description
Getting Started Install, configure, connect to your agent

Reference

Topic Description
Config Reference Full YAML schema, auth types, parameters, stdin, interactive, shadow
CLI Reference All commands, subcommands, flags, and environment variables

UI

Topic Description
Web UI Built-in browser interface for browsing, testing, and managing tools

Features

Topic Description
Vault Encrypted secret storage with per-entry encryption
Store Agent-writable workspace state — cross-run scratchpad for the agent ({{store:KEY}}, factorly.store.*)
OAuth OAuth 2.0 authentication with PKCE and auto-refresh
OpenAPI Import Generate tools from OpenAPI/Swagger specs
Project Directory Modular configs with .factorly/ and tools_dir
Logging Call log format, fields, output savings, and security
Blueprints Sharable tool/workflow bundles — 40+ bundled for popular services, plus install-from-GitHub/URL/file
Workflows Sequential tool pipelines with variable passing, state persistence, and per-step oversight
Code Tools Run sandboxed Go scripts as tools — power-user authoring (type: code) and agent-authored (factorly.code)
Workspaces Named variable + vault overlays for swapping environments (--workspace staging, --workspace prod)
Expressions Condition language for workflow if: and switch: — comparisons, boolean logic, jsonpath

Examples

Topic Description
Examples 27 end-to-end examples: getting started, auth, oversight, integrations, and more

Contributing

Topic Description
Development Building, testing, and project structure

Specs

Topic Description
OAuth Server Spec Planned: MCP-spec OAuth 2.1 authorization server design

Philosophy

  • Wrap, don't replace. Your tools don't change. Factorly sits in front.
  • Zero lock-in. Remove Factorly and everything still works.
  • Credentials are not your agent's business. Secrets live in Factorly, not in your agent.
  • Log everything. If an agent did it, there's a record.

← Back to README