Senu
Declare a Rust function once. Serve it as a web page, a JSON API and an MCP tool.
Guide and course ·
API reference ·
Changelog ·
Security
Senu is an open-source Rust library. You declare a read-only function once,
with its permission and parameters, and Senu serves it as an HTML page
rendered with Askama, a JSON API on
Axum and an MCP
tool for AI assistants built with the official
rmcp SDK. All three run the
same steps in the same order: size limits, the method, authentication, the
permission, the parameter envelope, your function, and one fixed error
mapping. The tests that prove it ship as a kit that you run over your own
routes.
To build from the Git tag instead of crates.io:
A complete application
This is examples/hello.rs after its imports: one
operation behind a Bearer token, also listed as an MCP tool.
// 1. Your state. Here it is one string; in a real service it holds a
// database pool.
// 2. A permission, and a principal that holds it.
const GREET: Permission = new;
const GUEST: Principal = new;
// 3. The function: state, caller and arguments in, a result or a safe
// error out. It knows nothing about HTTP or MCP.
// 4. The declaration. It exposes nothing by itself.
const GREETING: = Operation ;
// 5. Exposure: one JSON route and one MCP tool, both listed by hand.
async
$ HELLO_TOKEN=choose-a-long-random-value cargo run --example hello &
$ curl -H 'Authorization: Bearer choose-a-long-random-value' 'http://127.0.0.1:3000/api/greeting?name=Ada'
{"message":"Hello, Ada!"}
examples/inventory.rs goes further: asynchronous
operations, an authenticator of its own that reads X-Api-Key, two
tenants, an HTML page, a stylesheet and MCP.
tests/example_inventory.rs runs Senu's
contract over it.
What you get
- One declaration, three transports.
Operationholds the name, the description, the permission, the string parameters and the function.Endpointslists the routes andmcp::toolthe tools. Declaring exposes nothing; only what you list is reachable. - One order of checks. Authentication comes before the permission, and the permission before any validation, on HTML, JSON and MCP alike. A caller without the permission learns nothing about valid input.
- Your authentication.
auth::Authenticateturns request headers into a server-sidePrincipal. Bearer and Basic are built in; sessions, API keys in a database or a proxy header are an implementation of the trait. A route whose authenticator is missing is refused at startup. - Synchronous or asynchronous functions.
Run::Syncfor work in memory,Run::Asyncfor anything that waits. - Safe errors. Every error is a fixed code and phrase, so none can
repeat the input or a secret.
OpError::Internalcarries no detail. - The contract as a test kit.
senu::contract::check(featurecontract) sends real requests through your routes and tools and checks seven rules, CT-1 to CT-7. - A plain
axum::Router. Bind it where you like and add tower layers for logging, timeouts and rate limits.
The guide explains each part: operations, authentication, MCP tools, deployment, testing and questions and comparisons. AI assistants can read llms.txt.
Status and limits
Version 0.2 is the first release meant for use as a library. Its API is documented and its contract is tested, and it is honest about what it is not:
- Read-only. Operations are served by
GETand every MCP tool is marked read-only. There are no write operations, forms or CSRF tokens. - Strings and exact paths. Parameters are strings, which an operation parses itself, and there are no path parameters.
- MCP over stdio only. A stdio server trusts the local process that starts it. There is no MCP over HTTP.
- No sessions, login pages or OAuth. They belong in your
Authenticateimplementation and your own routes. - No TLS, logging, timeouts or rate limits. They belong in front of the router or in tower layers.
- Not audited, pre-1.0. Senu has had no independent security audit and makes no performance claim. A 0.x minor version may change the API; CHANGELOG.md lists every change.
Spec 0006 defines this release.
Features
| Feature | Default | What it adds |
|---|---|---|
demo |
yes | The catalogue demo, the senu binary and the article site with the course. A dependent turns it off with default-features = false. |
contract |
no | senu::contract, the test kit. Enable it under [dev-dependencies]. |
The rest of this README describes the demo, the course and development in this repository.
Aims (MCS): minimal, consistent, spec-driven
- Minimal: application developers should own as little code,
configuration and duplication as possible. A new operation is a
declaration plus one line per route and tool, a new article is one
Markdown file, and a change of look is classes in a template plus
npm run css. - Consistent: one set of conventions for people and AI tools, kept by
rustfmt,clippy -D warnings, the contract tests and, for the stylesheet, a CI drift gate. These check form and the adapters; they do not prove that your business rules are right. - Spec-driven: a spec in docs/specs/ comes first, then tests, then code; the development log records the checks that were actually run.
Rust is the foundation for its memory and type safety and its speed, but the language alone does not make a program secure or fast.
New to Rust? Start with the course
The beginner course is part of the site, online at https://efg-technologies.github.io/senu/start.html (English) and https://efg-technologies.github.io/senu/ja/start.html (Japanese). It has you run the same site on your own computer. Install Rust and Git as its installation chapter describes, then run:
cd ~
git clone https://github.com/efg-technologies/senu.git
cd ~/senu
cargo run --quiet -- site
The first build takes several minutes. Then open http://127.0.0.1:3000/
(English) or http://127.0.0.1:3000/ja/ (Japanese). The course needs no
credentials; The site and senu site has the
details.
The demo: senu serve and senu mcp
The senu binary is a local demo of the library, not a product.
- Fixed demo data. The catalogue is five projects in two tenants, built into the binary and held in memory. Nothing is stored, and there are no mutations.
senu servelistens on a loopback address only./projectsuses HTTP Basic and/api/projectsuses a Bearer token. There is no TLS, so the credentials travel in cleartext over loopback, where other local users can reach them.senu mcp --enable-mcpspeaks MCP over stdio and is off unless that flag is given.SENU_MCP_TOKENmust be set before it starts. Under the MCP authorization spec, stdio servers take credentials from the environment, so this trusts the local process that launches Senu. It does not authenticate any remote party.
Quickstart
You need the Rust toolchain pinned in rust-toolchain.toml (for example
through rustup), bash, curl and python3. From a clone, run
scripts/quickstart.sh. This is the whole script:
#!/usr/bin/env bash
# Senu quickstart: build, call the JSON API and the HTML page, then call the
# MCP tool over stdio and check every reply. Run it from a clone of the
# repository; it needs cargo, curl and python3. The credentials are demo values
# for a loopback-only server; choose your own for anything else.
|| { ; ; }
senu=./target/debug/senu
log=
SENU_BIND=127.0.0.1:0 SENU_WEB_USER=demo SENU_WEB_PASSWORD=demo-password \
SENU_API_TOKEN=demo-api-token &
server=
url=
for; do
url=
[ && break
done
[ || { ; ; }
|
SENU_MCP_TOKEN=demo-mcp-token
The MCP step runs scripts/check_mcp.py, a small client that uses only the
Python standard library. It waits for the initialize reply before calling
the tool, and it fails, killing the server, unless each reply carries the
request's id, no JSON-RPC error and no isError, and the call returns
acme-001 and acme-003. Any failed step makes the quickstart exit non-zero.
The HTML output shows Askama's escaping: the demo project named
<script>alert('x')</script> & "Launch" Notes is rendered as text.
The site and senu site
senu site serves the library guide and a beginner course for people who
know no Rust, written as Markdown articles in content/en and content/ja
and served by Senu itself on a loopback address:
cargo run --quiet -- site
Then open http://127.0.0.1:3000/ (English) or http://127.0.0.1:3000/ja/ (Japanese). The course starts with a visible page in the browser, has the learner write notes, and then rebuild the reading-time function test first; two optional appendices cover the catalogue, the API and MCP.
Any file named like content/en/51-my-note.md (two digits, a lowercase slug
and .md) becomes the page /my-note the next time cargo run or
cargo build runs: build.rs embeds the files, so the binary reads nothing
at run time and needs a rebuild after every change. The first line must be a
# Title. Raw HTML is shown as text, images are refused, and links must name
an existing page exactly or start with https://; a broken rule stops
startup with the file, the line and the reason. The content is trusted,
written by the repository's authors; this is not a system for untrusted
input. senu site takes only SENU_BIND and refuses every credential
variable; it has no /projects, /api/* or MCP routes.
Spec 0003 describes the
articles, the site and the course; it supersedes the mdBook tutorial of
spec 0002.
The public site is a static snapshot of the same pages.
python3 scripts/snapshot_site.py --base-url https://efg-technologies.github.io/senu/ target/site
starts senu site with SENU_SITE_URL, so that every page names its
canonical address, its translations and its structured data, and adds
sitemap.xml, robots.txt, llms.txt, llms-full.txt, each article's
Markdown source and 404.html. The pages workflow deploys that directory
to GitHub Pages from main. Articles numbered 10 to 49 are the guide, 00
to 09 the course, 50 to 89 notes and 90 to 99 appendices.
Commands
| Command | What it does |
|---|---|
senu serve |
HTML and JSON on SENU_BIND (default 127.0.0.1:3000, loopback IP literals only, port 0 allowed) |
senu site |
the Markdown articles as HTML on SENU_BIND, with no credentials; SENU_SITE_URL (an https:// address ending in /) adds canonical addresses and structured data |
senu mcp --enable-mcp |
MCP over stdio until stdin closes; exits 0 on EOF |
senu --help |
usage |
serve needs SENU_WEB_USER (1–64 visible ASCII characters, no :),
SENU_WEB_PASSWORD and SENU_API_TOKEN (1–256 visible ASCII characters).
mcp needs SENU_MCP_TOKEN. All credentials must differ, and unknown
SENU_* variables are rejected. A configuration error exits 2 and names the
variable without printing its value; a bind failure exits 1. Tenants and
roles cannot be configured.
Routes and the MCP tools
GET /projects?q=(Basic): an HTML list with a search form.GET /api/projects?q=(Bearer): JSON{"projects": [{"id", "name"}]}.GET /project?id=(Basic): one project's HTML page.GET /api/project?id=(Bearer): JSON{"id", "name"}.GET /_senu/ui.css(no credentials, also undersenu site): the stylesheet,text/css, served from memory./_senu/is reserved for Senu; every other path below it is 404.- MCP tool
list_projects:readOnlyHint: true, optional stringq, no other fields. Results come back asstructuredContentand as JSON text; operation errors areisErrorresults with{"error": code}. An unknown tool gets JSON-RPC error-32602and a method that rmcp does not recognise gets-32601; both carry fixed messages that do not repeat the requested name. - MCP tool
get_project:readOnlyHint: true, required stringid, no other fields, with the same results and errors.
id is required: 1 to 32 characters of a-z, 0-9 and -, matched
exactly; any other value is invalid_id (400). An id that is unknown or
belongs to another tenant is not_found (404) on every transport.
q is trimmed, then matched case-insensitively against project names. After
trimming it may hold up to 80 Unicode scalar values and no control characters. Unknown fields are rejected.
Every other path returns 404 and every other method 405. Request bodies
(413) and targets over 2048 bytes (414) are refused, and credentials in the
query string are never read. Responses carry Cache-Control: no-store and
X-Content-Type-Options: nosniff, and errors never repeat input or secrets.
Adding an operation
In your own crate, follow examples/inventory.rs
and the operations guide.
In this repository the application is the demo in src/demo/, and Senu's
adapters are in src/http.rs and src/mcp.rs.
| The application owns | Senu owns |
|---|---|
state, tenants and principals; the authenticators' credentials or its own Authenticate; Permission constants; each operation's function, argument struct, result, error codes and Operation declaration; views and templates; the route table and the tool list; business tests |
the Basic and Bearer authenticators, limits, the method check, the permission before the parameter envelope, error mapping, the CSP and headers, JSON Schemas from the parameters, route and tool validation at startup, and the contract kit |
- Add
src/demo/<name>.rswith a private functionfn(&S, &Principal, &Args) -> Result<T, OpError>that decodes withoperation::decodeinto a#[serde(deny_unknown_fields)]struct, and apub const OPERATION: Operation<S, T>with its name, description, permission, string parameters andrun: Run::Sync(function). Errors of its own areOpError::Invalid { code, phrase }(400) orOpError::NotFound. - List it in
src/demo/mod.rs:.html(path, &OPERATION, view)or.api("/api/…", &OPERATION)inendpoints(), andmcp::tool(&OPERATION)intools(). An operation that is declared but not listed is not exposed. - Write its business tests next to it, add one succeeding sample to
demo_subjectintests/contract.rs, which then runs CT-1 to CT-7 over it, and list the routes and the tool in both READMEs, whichtests/docs_sync.rschecks.
Limits: parameters are strings and paths are exact. Anything else goes
through .custom(path, handler), which gets the size limits and response
headers but no authentication, method check or CSP; the handler does those
itself, and the contract tests do not cover it. Operation::call checks
the declared permission before the envelope and the envelope before the
function; any further policy inside the function runs after the envelope.
An invalid route table or tool list makes senu serve or senu mcp exit
with status 2 before it binds or reads stdin.
Migration from 0.1 (spec 0006, §9): the demo's routes, bodies, headers,
schemas and error codes are unchanged. run: f becomes run: Run::Sync(f).
Operation::call and McpServer::call are async. Principal::tenant()
returns &TenantId, which lives in operation and is no longer Copy;
Project is no longer Copy either. OpError::InvalidSearch,
OpError::InvalidId and their HttpError forms are associated constants
equal to Invalid { code, phrase }, available with the demo feature, so
they still work in expressions and patterns. The error enums are
#[non_exhaustive] and gained Internal, so a match needs a wildcard
arm. AppState and McpServer no longer default their state type to
Catalogue; write McpServer<Catalogue>. AppState::new,
with_principals, http::router, McpServer::new, with_principal,
mcp::tools, TOOL_NAME, GET_PROJECT_TOOL, operation::list_projects,
operation::get_project and Principal::demo_* keep their paths under
demo. Permission::ListProjects and Permission::ViewProject remain
associated constants, as since spec 0005.
Templates
Templates are Askama .html files with HTML escaping on. askama.toml
configures an ERB-like syntax:
<%# comments %>
<%! for p in projects %>
<li data-project-id="<%= p.id %>"><%= p.name %></li>
<%! endfor %>
Blocks use <%! %>, expressions <%= %> and comments <%# %>. Plain <%
for blocks does not work, because Askama rejects a delimiter that is a prefix
of another. A test fails if a template or the configuration uses the safe
filter or turns escaping off. The one exception is TrustedHtml, which
only src/markdown.rs can build: the article body from the Markdown
policy, and the JSON-LD element, whose <, > and & are \u escapes.
The same test requires exactly one HtmlSafe impl in src/, on that
type. The senu serve pages extend
serve_base.html, which holds the head, the stylesheet link and the demo
banner.
Look: Tailwind CSS and Typography
The pages use Tailwind CSS utility classes in
templates/*.html and the official Typography plugin's prose styles for
article text. Change the look by editing classes in a template, or theme
variables for every page in assets/ui.css, the only CSS source:
@}
Tailwind writes rules only for the classes it finds in the templates, into
assets/ui.generated.css. That file is committed and built into the
binary, so Cargo alone builds and runs Senu; Node is needed only to change
the look. With Node 24 and its npm:
Commit the source together with assets/ui.generated.css. CI runs
npm ci, npm run css and git diff --exit-code -- assets/ui.generated.css,
and cargo test fails when a template class has no rule. Typography keeps
its own colours, so @theme does not change link colours inside articles;
a prose-a: class on <main> in templates/site_base.html does. The
licenses of both packages are in THIRD-PARTY-NOTICES.txt,
and the stylesheet keeps their notices.
Development
RUSTDOCFLAGS="-D warnings"
tests/contract.rs runs the contract kit over every listed route and tool
of the demo and of a test-only second application, tests/library.rs
covers the library API, and tests/example_inventory.rs runs the kit over
examples/inventory.rs. The tests also include
tests/quickstart_check.rs, which runs the quickstart's MCP
checker against fake servers, and tests/tutorial_checker.rs, which runs the
own tests of the tutorial checker and of the site snapshot; both need
python3. check_tutorial.py runs
the course in English and then in Japanese, each in a temporary copy of the
last commit, and leaves the working tree unchanged; commit your changes
first, because it refuses to run while tracked files differ from HEAD.
The course's optional last section runs npm ci, so check_tutorial.py
also needs Node 24, npm and access to the npm registry.
snapshot_site.py needs a new or empty directory; it starts senu site,
saves every page as a static file with relative links, the stylesheet and
the notices, and checks them. CI
runs the same commands on GitHub-hosted Ubuntu; the pages workflow builds
the public snapshot and, on main, deploys it. Read
the specs, the development log and
the research notes for the details.
License
Senu is licensed under Apache-2.0.