mirror of
https://github.com/wiltodelta/remove-ai-watermarks.git
synced 2026-10-19 23:47:30 +02:00
Victor KuznetsovandClaude Opus 5.5
06c0cb1bbe
- .codex-plugin/plugin.json and assets/icon.svg package the existing skill tree for Codex plugin catalogs; skill version 1.0.12 across all manifests - `remove-ai-watermarks mcp` serves identify, remove and batch over stdio, one CLI command per tool call, standard library only; server.json and glama.json for the MCP registry and Glama - Pin every GitHub Action to a commit SHA - Call module.train(False) instead of module.eval(), which plugin scanners read as dynamic code execution Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
92 lines
4.0 KiB
Markdown
92 lines
4.0 KiB
Markdown
# MCP server
|
|
|
|
`remove-ai-watermarks mcp` runs a [Model Context Protocol](https://modelcontextprotocol.io/)
|
|
server on stdin and stdout, so an agent client can identify and clean the
|
|
user's own images and video without a shell. It is a thin wrapper: each tool
|
|
runs one command of this CLI in a child process and returns that command's exit
|
|
code, output path and text.
|
|
|
|
The subcommand ships in the first release after 0.45.1. The server uses only
|
|
the Python standard library, so the default package runs it. The commands behind
|
|
a tool need the same extras they need on the command line
|
|
([CLI guide](cli.md#command-dependency-map)). A missing extra comes back as a
|
|
tool error carrying the CLI's install hint.
|
|
|
|
## Client configuration
|
|
|
|
Most clients take a command and arguments. With [uv](https://docs.astral.sh/uv/):
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"remove-ai-watermarks": {
|
|
"command": "uvx",
|
|
"args": ["remove-ai-watermarks", "mcp"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
To make visible-mark removal and pixel detectors available, name the extras:
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"remove-ai-watermarks": {
|
|
"command": "uvx",
|
|
"args": ["--from", "remove-ai-watermarks[visible,video]", "remove-ai-watermarks", "mcp"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
An existing installation can be started directly as `remove-ai-watermarks mcp`.
|
|
Paths in tool calls are read and written on the machine that runs the server.
|
|
|
|
## Tools
|
|
|
|
| Tool | Runs | Writes |
|
|
| --- | --- | --- |
|
|
| `identify` | `identify --json`, or `video identify --json` for a video suffix; `check_visible: false` adds `--no-visible` | Nothing |
|
|
| `remove` | `metadata --remove`, `visible` or `all` for an image; `video metadata --remove`, `video visible` or `video all` for a video | One output file, `<name>_clean` beside the source unless `output` is given |
|
|
| `batch` | `batch --mode` for images or `video batch --mode` for video | A separate output directory, `<dir>_clean` unless `output_dir` is given |
|
|
|
|
`mode` is `metadata` (the default), `visible` or `all`. For an image, `all`
|
|
adds the invisible-watermark scrub where the installed extras and a CUDA GPU
|
|
allow it; `video all` removes visible marks and metadata only. The server never
|
|
writes over an input: an `output` equal to the source, or an `output_dir` equal
|
|
to the input directory, is refused before anything runs.
|
|
|
|
Exit codes keep their CLI meaning. `0` and `2` are results, not tool errors, and
|
|
`2` means no supported signal was found, which is unknown rather than clean.
|
|
Click also exits `2` on a usage error such as a missing file; its `Usage:` line on
|
|
stderr marks that case as a tool error. Every other nonzero exit code is returned
|
|
with `isError: true` and the command's stderr.
|
|
|
|
## Scope
|
|
|
|
The server carries the project's intended-use boundary in its `instructions`:
|
|
it is for content the user generated or edited themselves, and not for stock,
|
|
agency, marketplace or other marks that protect a third party's asset. See
|
|
[legal and safety](legal-and-safety.md).
|
|
|
|
## Protocol
|
|
|
|
The server answers the initialize handshake for protocol versions 2025-11-25,
|
|
2025-06-18, 2025-03-26 and 2024-11-05, and lists its tools with input schemas
|
|
and annotations: `identify` is read-only, and `remove` and `batch` write new
|
|
files without destroying inputs. It does not implement `server/discover`. A
|
|
client that probes it first, such as the official Python SDK's `Client` in its
|
|
default mode, receives method-not-found and falls back to the handshake.
|
|
`tests/test_mcp_server.py` runs that client against the real subcommand.
|
|
|
|
## Registry listing
|
|
|
|
[`server.json`](../server.json) describes the PyPI package for the
|
|
[official MCP registry](https://registry.modelcontextprotocol.io/) under
|
|
`io.github.wiltodelta/remove-ai-watermarks`. The registry verifies ownership by
|
|
the `mcp-name:` marker in `README.md`, which becomes the PyPI description, so it
|
|
can only verify a release whose README carries that marker.
|
|
[`glama.json`](../glama.json) names the maintainer for Glama. Publishing steps
|
|
are in [release and distribution](release-and-distribution.md#mcp-registry).
|