Read-only MCP server that brings FirmaUY signature inspection to your AI assistant. Offline, no smart card, no signing, redacted by default.
Project description
firmauy-mcp-inspect
firmauy-mcp-inspect is a small, read-only MCP server that
lets an AI assistant inspect documents signed with a Uruguayan cédula de identidad using
FirmaUY. It verifies signatures (PDF/PAdES, XAdES XML,
or a detached CMS .p7s) and validates cédula check digits. Verification runs offline and does not
require a smart card.
It exists for the one task where an assistant genuinely beats the bare CLI, triaging a batch of signed documents in plain language. Point it at a folder and it verifies every file, groups the results by issuing CA, and flags anything that is not VALID or whose certificate chain is not trusted, leaving you a summary to act on.
By design it only ever inspects. It cannot sign, never sees a PIN, and redacts the signer's personal data by default, so identities stay out of the model's context.
Scope (inspection only, by design)
FirmaUY can also sign with the national ID card and read the cardholder's data. This server deliberately exposes neither of them.
- No signing. A signature with a national ID is a legally significant act that needs the physical card and a PIN. A model must never be able to trigger it. Signing stays a human, manual action.
- No identity or photo.
fetch-identityandfetch-photoreturn personal and biometric data. That must not flow into a model's context, so those commands are not exposed.
What the model sees from verification carries no personal data. The model receives the
indication, the trust status, and the issuer (a public CA), but not the signer's name or document
number. That is not a default the model can override: no tool takes an argument for it. Letting
identifying data through is the operator's decision, made once at startup with
FIRMAUY_MCP_ALLOW_PII (see Configuration).
Why a subprocess and not the Python API
FirmaUY ships a public Python API (firmauy.api) that this server could import instead of running
the CLI. That would be a mistake here, and the process boundary is deliberate:
- The capability stays out of the process. Importing
firmauy.apiwould load signing and cardholder-data reading into the same process as the model-driven code, one attribute away. Running the CLI means those capabilities are not present at all, which is a stronger guarantee than being present and not called. To be precise about what this does and does not buy: signing still exists in thefirmauyexecutable on the host. What this server guarantees is that it is absent from this process and unreachable from it, because the argument list of every call is built in code and no tool accepts a subcommand from its caller. - The
--jsonoutput is a versioned contract. It carries aschema_versionand changes far more slowly than the young library API. - Timeouts actually work.
subprocesskills a hung process. A blocking in-process call cannot be cancelled that way in Python.
The cost is a process spawn per call, which is irrelevant next to those three.
Tools
| Tool | What it does |
|---|---|
verify(path, original=None) |
Verify one signed file (PDF/PAdES, XAdES XML, detached CMS/.p7s). Returns the indication, per-signature trust, checks, and the signature timestamp. |
verify_batch(paths) |
Verify many files. Returns a summary count by indication plus a compact per-file result (indication, trusted, issuing CA, and how that file's timestamps came out). |
validate_ci(number) |
Validate a cédula's check digit (arithmetic consistency only, not an identity check). |
doctor() |
Report the local setup status (PC/SC, PKCS#11 module, card, bundled CAs). Every check's status is reported; the card and token details are withheld, since some PKCS#11 modules use the cardholder's name as the token label. |
None of them takes a redaction argument: whether personal data may reach the model is set by the operator at startup, not chosen per call.
verify_batch handles self-contained signatures (PDF/PAdES, XAdES XML). A detached .p7s needs its
original file, so verify those one at a time with verify(path, original=...).
Verification is offline, with certificate-chain validation up to the Uruguayan national root. A
VALID result is a technical assessment, not a statement of legal validity. For authoritative
verification, use AGESIC's official validator. This is an independent, unofficial tool,
not affiliated with or endorsed by AGESIC.
Requirements
The firmauy CLI must be installed and on PATH, version 1.13.1 or newer.
That is where a signature timestamp's integrity, validity and trust became three separate answers,
where --tsa-ca started applying to every format instead of being accepted and ignored on some, and
where a malformed timestamp token started coming back as INDETERMINATE instead of raising. This
server reports what the CLI concludes, so on older semantics it would be announcing timestamp trust
the CLI never established.
An older CLI is refused, not tolerated: the server checks the version once at startup and every
tool returns an error rather than running. This is deliberate. The packaging requirement only binds
an install that pulls firmauy in as an extra, and the documented way to run this is a separately
installed CLI or FIRMAUY_BIN, neither of which pip ever sees.
uv tool install firmauy
firmauy --version
It is an extra rather than a hard dependency, so you can pin the CLI version yourself or reuse one
you already have. To pull it in with the server instead, install the cli extra:
uv tool install firmauy-mcp-inspect --with firmauy # or: pip install "firmauy-mcp-inspect[cli]"
(Override the executable with the FIRMAUY_BIN environment variable if it lives elsewhere.)
Configuration
All are optional and configured through environment variables.
| Variable | Default | Purpose |
|---|---|---|
FIRMAUY_BIN |
(found on PATH) |
Path to the firmauy executable, if it is not on PATH. |
FIRMAUY_MCP_TIMEOUT |
60 |
Per-call timeout, in seconds, for each firmauy invocation. |
FIRMAUY_MCP_MAX_WORKERS |
8 |
Max concurrent verifications in verify_batch. Set to 1 for sequential. |
FIRMAUY_MCP_ALLOWED_ROOTS |
none (no limit) | Directories the tools may read from, separated by the OS path separator (: on Linux/macOS, ; on Windows). When set, any path outside them (after resolving symlinks and ..) is refused. |
FIRMAUY_MCP_ALLOWED_EXTENSIONS |
none (no limit) | Comma-separated types allowed for the signed file, e.g. .pdf,.xml,.p7s. Does not restrict a detached .p7s's original. |
FIRMAUY_MCP_ALLOW_PII |
false |
Let identifying data reach the model: the signer's name and document number, and the card and token check details. Off by default, and no tool can override it. Turn it on only if you understand that this data will enter (and usually leave with) the model's context. |
FIRMAUY_MCP_TSA_CA |
none | Path to a PEM bundle of timestamping authority certificates. When set, a signature timestamp's own chain is validated against it and timestamp.trusted becomes true or false. Unset, it stays null: nothing was evaluated, which is not the same as untrusted. Like ALLOW_PII, no tool can override it. |
A malformed numeric override is ignored (it falls back to the default) rather than failing startup.
FIRMAUY_MCP_TSA_CA is different: if it is set and the file is not there, the server refuses to
start. Carrying on would report every timestamp as unvalidated while the setting says otherwise,
which is wrong and silent.
Timestamps and who vouches for them
The two trusts in a result answer different questions and neither implies the other.
signature.trusted is the signer's chain to the Uruguayan national root. signature.timestamp.trusted
is the timestamping authority's chain to the roots you configured here, and it is three-valued:
null means no roots were configured and nothing was looked at, false means they were and it did
not chain. A file can be VALID with a timestamp that is only asserted.
Which authorities count is deliberately yours to decide and not the model's. Letting a tool argument pick its own trust roots would let the model define the policy it is being measured against.
Note what this does not settle: under Ley 18.600 art. 6 a document makes proof of its date only through a provider accredited by the UCE. A timestamp validated against any other authority is real cryptographic evidence of when the signature existed, and is not that.
Sandboxing (recommended)
This server hands file paths from the model to firmauy, which opens them. Confining what it can
read matters for a tool that touches national-ID signatures, so set both allowlists. They are
opt-in and fail closed.
export FIRMAUY_MCP_ALLOWED_ROOTS="/srv/inbox/signed"
export FIRMAUY_MCP_ALLOWED_EXTENSIONS=".pdf,.xml,.p7s"
Containment is checked on the resolved, canonical path (symlinks and .. followed), so it is not
fooled by traversal, symlink escapes, or sibling directories sharing a name prefix. The root
allowlist also covers the original of a detached .p7s. The extension allowlist does not, because
that original is arbitrary content.
Install
uv tool install firmauy-mcp-inspect
This puts the firmauy-mcp-inspect command on your PATH, which starts the server over stdio. You
can also run it without installing, straight from PyPI, with uvx firmauy-mcp-inspect.
Try it interactively with the MCP Inspector.
npx @modelcontextprotocol/inspector firmauy-mcp-inspect
To work on it from a clone instead, run uv sync and then uv run firmauy-mcp-inspect.
Docker
A prebuilt image is published to the GitHub Container Registry on every release, so you can run
the server without installing Python or the firmauy CLI.
docker pull ghcr.io/carlosplanchon/firmauy-mcp-inspect:latest
Mount a directory with signed documents and pass any configuration via environment variables:
docker run -i --rm \
-v /srv/inbox:/srv/inbox:ro \
-e FIRMAUY_MCP_ALLOWED_ROOTS=/srv/inbox \
-e FIRMAUY_MCP_ALLOWED_EXTENSIONS=.pdf,.xml,.p7s \
ghcr.io/carlosplanchon/firmauy-mcp-inspect:latest
Paths you ask the tools to inspect must exist inside the container, so mount the documents
(read-only via :ro, since the server only ever reads them, at the same path on both sides) and point
FIRMAUY_MCP_ALLOWED_ROOTS at the container path. The container speaks the MCP stdio transport
(hence -i), so let your MCP client manage it.
Claude Code
claude mcp add firmauy-inspect -- \
docker run -i --rm \
-v /srv/inbox:/srv/inbox:ro \
-e FIRMAUY_MCP_ALLOWED_ROOTS=/srv/inbox \
-e FIRMAUY_MCP_ALLOWED_EXTENSIONS=.pdf,.xml,.p7s \
ghcr.io/carlosplanchon/firmauy-mcp-inspect:latest
Claude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"firmauy-inspect": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-v", "/srv/inbox:/srv/inbox:ro",
"-e", "FIRMAUY_MCP_ALLOWED_ROOTS=/srv/inbox",
"-e", "FIRMAUY_MCP_ALLOWED_EXTENSIONS=.pdf,.xml,.p7s",
"ghcr.io/carlosplanchon/firmauy-mcp-inspect:latest"
]
}
}
}
To build the image yourself instead (for example from a clone), a Dockerfile is included:
docker build -t firmauy-mcp-inspect .
Configure your client
Both forms below assume firmauy-mcp-inspect is on your PATH from uv tool install. If a GUI
client cannot find it, use uvx as the command ("command": "uvx", "args": ["firmauy-mcp-inspect"])
or give the absolute path.
Claude Code
claude mcp add firmauy-inspect -- firmauy-mcp-inspect
Claude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"firmauy-inspect": {
"command": "firmauy-mcp-inspect"
}
}
}
Then ask it things such as "Verify every signed PDF in this folder, group them by issuing CA, and flag anything that is not VALID or whose chain is not trusted."
Tests
uv run pytest
The tests mock the firmauy subprocess, so they need neither the CLI nor a card. The
path-sandboxing tests additionally create temporary files and a symlink on the local filesystem.
Contributing & security
Pull requests are welcome. The mechanics, including the required
DCO sign-off (git commit -s) and the two properties a change
must not weaken, are in CONTRIBUTING.md.
Found a way past the reduced authority, the redaction or the path sandbox? Report it privately: see SECURITY.md, not a public issue.
License
Apache-2.0.
Project details
Release history Release notifications | RSS feed
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 firmauy_mcp_inspect-0.4.0.tar.gz.
File metadata
- Download URL: firmauy_mcp_inspect-0.4.0.tar.gz
- Upload date:
- Size: 29.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ea88f9a904abad9faa204f4697ba0b079ade76e3d388f8a438aee00c4694821c
|
|
| MD5 |
cdc81aefd4b0eda5c91c2caf44929f6b
|
|
| BLAKE2b-256 |
4bf875648041cc28200828b0b55297a2a6be0687e04a3b59c4d7eeabb4d2af6b
|
Provenance
The following attestation bundles were made for firmauy_mcp_inspect-0.4.0.tar.gz:
Publisher:
release.yml on carlosplanchon/firmauy-mcp-inspect
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
firmauy_mcp_inspect-0.4.0.tar.gz -
Subject digest:
ea88f9a904abad9faa204f4697ba0b079ade76e3d388f8a438aee00c4694821c - Sigstore transparency entry: 2332206871
- Sigstore integration time:
-
Permalink:
carlosplanchon/firmauy-mcp-inspect@2b7f4d7dd9e3eb9857c7023b9234589a1d121bef -
Branch / Tag:
refs/tags/v0.4.0 - Owner: https://github.com/carlosplanchon
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@2b7f4d7dd9e3eb9857c7023b9234589a1d121bef -
Trigger Event:
push
-
Statement type:
File details
Details for the file firmauy_mcp_inspect-0.4.0-py3-none-any.whl.
File metadata
- Download URL: firmauy_mcp_inspect-0.4.0-py3-none-any.whl
- Upload date:
- Size: 19.7 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 |
f44454c258fa4b90aa1ac1ffc9040256fe020822847b97d46ba97103fb7bde31
|
|
| MD5 |
5851cc4d6e8f8fb4aa8372543ff18dd8
|
|
| BLAKE2b-256 |
d29450afcda3efddac1713191aa8befde2f4e795e9d75d32eb23577f6bc6f38b
|
Provenance
The following attestation bundles were made for firmauy_mcp_inspect-0.4.0-py3-none-any.whl:
Publisher:
release.yml on carlosplanchon/firmauy-mcp-inspect
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
firmauy_mcp_inspect-0.4.0-py3-none-any.whl -
Subject digest:
f44454c258fa4b90aa1ac1ffc9040256fe020822847b97d46ba97103fb7bde31 - Sigstore transparency entry: 2332207141
- Sigstore integration time:
-
Permalink:
carlosplanchon/firmauy-mcp-inspect@2b7f4d7dd9e3eb9857c7023b9234589a1d121bef -
Branch / Tag:
refs/tags/v0.4.0 - Owner: https://github.com/carlosplanchon
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@2b7f4d7dd9e3eb9857c7023b9234589a1d121bef -
Trigger Event:
push
-
Statement type: