foro (Python)
The Python SDK and CLI for foro.sh — the fastest path from
"I want to build an MCP server" to a deployed https://<slug>.foro.sh URL.
Quickstart
uvx foro init my-server && cd my-server
uvx foro dev
foro init scaffolds a working FastMCP server;
foro dev runs it exactly as foro.sh will and confirms it would pass the
platform's health check. Once it looks good:
git init && git add -A && git commit -m "init" && gh repo create --push
Then, on the foro.sh dashboard: sign in with GitHub, pick the repo, add any secrets your tools need, and deploy.
CLI
Install once with uv tool install foro, or run ad-hoc with
uvx foro ... — no need to add it to your project's own dependencies.
| Command | What it does |
|---|---|
foro init [name] |
Scaffold a new project, or record an existing one's foro settings in its pyproject.toml (run with no argument). --yes takes every default without prompting, for CI and coding agents |
foro check [path] |
Validate a repo against foro.sh's deploy contract before you push |
foro dev [path] |
Run the server locally exactly as foro.sh will, and confirm it would pass the health check |
foro verify <url> |
Prove a deployed server actually serves MCP, by opening a session and listing its tools |
foro auth <login|status|logout|token> |
Sign in to foro.sh, so the CLI can act on your behalf |
foro check mirrors the platform's own validation rule for rule, so a repo
it passes will deploy and one it flags will not — the same reason code,
surfaced locally instead of as a 60-second health-check timeout.
foro verify applies foro dev's standard to a deployed server: a URL that
answers HTTP is not the same as one serving MCP, and a green deploy only means
the container passed a TCP probe. It runs the same handshake foro dev does —
initialize, then tools/list — and exits non-zero when that fails, so a
script or a CI step can branch on it.
$ foro verify https://swift-harbor-a3f2.foro.sh
✓ https://swift-harbor-a3f2.foro.sh/mcp is serving MCP
Tools: get_forecast, list_cities
The /mcp path is appended when you leave it off, so the URL foro deploy
printed works as-is.
Signing in
init, check and dev are entirely local and need no account. foro auth
is for everything that talks to foro.sh:
$ foro auth login
! First copy your one-time code: 7A2F-K9QP
Press Enter to open foro.sh in your browser...
- Waiting for authorization... 6s
✓ Logged in as danielsteman (workspace: acme)
A browser approves the code, the CLI polls until you do — the same device flow
gh auth login uses, so it works over SSH where a loopback redirect wouldn't.
- The token is workspace-scoped, picked when you approve it. Access to a second workspace means logging in again for a second token; there is no workspace-switch command.
foro auth statusvalidates against the API rather than reporting that a file exists, so a revoked token shows as broken. It exits 1 when you aren't authenticated, which is what a script should branch on.foro auth logoutrevokes the token server-side and deletes it here. If revocation fails it still deletes locally and tells you to finish the job on/account.foro auth tokenprints the raw token and nothing else, forcurl -H "Authorization: Bearer $(foro auth token)".
Credentials live in ~/.config/foro/hosts.yml ($XDG_CONFIG_HOME is honoured;
%APPDATA%\foro on Windows) at mode 0600, keyed by host. Two environment
variables override it:
| Variable | Effect |
|---|---|
FORO_TOKEN |
Use this token instead of the stored one, and never write it to disk — the GH_TOKEN convention. foro auth status says when it's in play |
FORO_HOST |
Point the CLI at another instance (localhost:3001 for a native dev stack). Defaults to foro.sh |
For CI, skip the browser entirely:
$ echo "$FORO_TOKEN" | foro auth login --with-token
Runtime
One import, used from your server's entrypoint:
from fastmcp import FastMCP
import foro
mcp = FastMCP("my-server")
@mcp.tool
def add(a: int, b: int) -> int:
return a + b
if __name__ == "__main__":
foro.run(mcp) # streamable HTTP, host 0.0.0.0, port $PORT - identical locally and deployed
| Function | What it does |
|---|---|
foro.run(server, *, port=None) |
The one correct way to start a server for foro.sh. Accepts any FastMCP-shaped server (standalone fastmcp.FastMCP, mcp.server.fastmcp.FastMCP, or a low-level Server) — it's duck-typed, not tied to a specific class. |
foro.secret(name) |
Read a required secret from the environment, raising a dashboard-actionable error if it's missing. Set secrets in your project's Secrets tab on the dashboard; they arrive as env vars at deploy time. |
Bare foro (what a deployed container installs — no [cli] extra) stays
dependency-free, so a deployed container never pulls in CLI tooling it
doesn't use.
Project config
There is no foro-specific manifest. A repo's pyproject.toml (Python) or
package.json (Node) already names the project and points at the file that
starts it, and that is what foro.sh reads:
| What foro needs | Python | Node |
|---|---|---|
| display name | [project].name |
name |
| runtime | a pyproject.toml is here |
a package.json is here |
| interpreter version | requires-python, resolved to the newest supported version it allows |
engines.node, same |
| entry file | server.py, main.py, src/server.py or app.py |
main, then bin, then index.js |
| dependency manager | the lockfile (uv, PDM, Poetry, pipenv, requirements.txt) |
the lockfile (npm, pnpm, yarn) |
The rest is optional, and only for what those files can't say:
# pyproject.toml - every key optional, most projects have no such table
[tool.foro]
entrypoint = "cmd/serve.py" # only when it isn't one of the names above
runtime_version = "3.13" # only to pin against what requires-python allows
port = 9000 # only when your server can't listen on $PORT
dependency_manager = "poetry" # only when a repo is genuinely ambiguous
egress = ["example.com:443"] # only to lock down outbound traffic
egress is absent by default, which keeps today's permissive outbound
traffic. Declaring it - even as [] - switches the container to
deny-by-default outbound, restricted to exactly the listed
<destination>:<port> entries (an IPv4 address, an IPv4 CIDR, or a
hostname). foro dev does not enforce it locally; it's a deploy-time
restriction only.
// package.json - the same keys, under "foro"
{ "foro": { "port": 9000 } }
At runtime the container gets PORT and every project secret as its own env
var. Public traffic arrives at
https://<slug>.foro.sh, so your server must listen on 0.0.0.0:$PORT —
which is exactly what foro.run() does for you.
Example
foro-sh/todo-mcp is a small stateful
todo-list server built the way described above — every new foro.sh workspace
gets a deployed copy of it to poke at before deploying anything of your own.
Develop this package
uv sync
uv run pytest
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file foro-0.12.1.tar.gz.
File metadata
- Download URL: foro-0.12.1.tar.gz
- Upload date:
- Size: 407.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
35cd6b7dd1bebce5e97b4d6ca692afb198b7ab702debfa0741ac9fd4f64b0cba
|
|
| MD5 |
383f2768c9f96326c1f14b013a723e3b
|
|
| BLAKE2b-256 |
8cf46334839a49a83fc0144751acd34a664d1bad91847b290761a8dc35b28599
|
Provenance
The following attestation bundles were made for foro-0.12.1.tar.gz:
Publisher:
publish-python.yml on foro-sh/foro
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
foro-0.12.1.tar.gz -
Subject digest:
35cd6b7dd1bebce5e97b4d6ca692afb198b7ab702debfa0741ac9fd4f64b0cba - Sigstore transparency entry: 2709945882
- Sigstore integration time:
-
Permalink:
foro-sh/foro@df16025a8f73be6b976b3d396b7bf127ab145039 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/foro-sh
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-python.yml@df16025a8f73be6b976b3d396b7bf127ab145039 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file foro-0.12.1-py3-none-any.whl.
File metadata
- Download URL: foro-0.12.1-py3-none-any.whl
- Upload date:
- Size: 48.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e48b59ab1af859290250c362ac67ae99c1325c1e2e25feb8b07dffede251d87
|
|
| MD5 |
11e0ebf8e92f637044ac196b3f7e795a
|
|
| BLAKE2b-256 |
5cf9eaaf343bfa4e953163be7745c57fbeeac19025385de8dbe6849cf4951ef8
|
Provenance
The following attestation bundles were made for foro-0.12.1-py3-none-any.whl:
Publisher:
publish-python.yml on foro-sh/foro
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
foro-0.12.1-py3-none-any.whl -
Subject digest:
8e48b59ab1af859290250c362ac67ae99c1325c1e2e25feb8b07dffede251d87 - Sigstore transparency entry: 2709945897
- Sigstore integration time:
-
Permalink:
foro-sh/foro@df16025a8f73be6b976b3d396b7bf127ab145039 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/foro-sh
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-python.yml@df16025a8f73be6b976b3d396b7bf127ab145039 -
Trigger Event:
workflow_dispatch
-
Statement type: