API map

A curated index of Fentaris APIs by implementation task.

Use this page as the compact entrypoint to the generated API reference. The full TypeDoc output remains available at API Reference (Auto).

Application and declarations

Task	Primary API	Guide
Create an app boundary	fentaris(...)	Proxy setup
Declare an upstream	app.mcp(...), mcp(...)	Servers and transports
Declare local capabilities	app.local(...)	Extension API
Start or stop the proxy	app.start(), app.stop()	MCP proxy

Governance and identity

Task	Primary API	Guide
Define allow/deny rules	policy(...), Policy	Policies
Define users	user(...), User	Identity and auth
Define groups	group(...), app.group(...)	Governance auth
Reference API-key hashes	credentialJson(...)	Governance auth
Reference upstream secrets	credential(...), bearer(...)	Security

Runtime behavior

Task	Primary API	Guide
Add middleware	app.use(...), scoped .use(...)	Middleware
Route one tool	.tool(...)	Middleware
Observe lifecycle events	.on(...), app events	Hooks
Emit structured logs	ctx.log, jsonConsoleLogger(...)	Logger
Require approval	approval, approval adapters	Telegram approval

Transports and placement

Task	Primary API	Guide
Start a stdio upstream	stdio(...)	Stdio transport
Connect Streamable HTTP	streamableHttp(...)	Servers and transports
Add a custom integration	extension contracts	Extension API
Configure edge execution	targets and placement bindings	Edge reference

CLI and project operations

Task	Command
Generate a project	fentaris init
Validate source/config	fentaris check --offline
Diagnose environment	fentaris doctor
Probe a running endpoint	fentaris doctor --runtime
Manage API keys	fentaris auth api-key
Manage credentials	fentaris secrets
Inspect declared tools	fentaris tools

See the CLI reference for flags, non-interactive usage, and machine-readable output.