Tools reference Leave feedback
On this page
Complete reference of every tool the GroupDocs.Redaction MCP server exposes to AI agents, with parameters, example prompts, and results. Captured from a live tools/list call against server version 26.9.0 (raw capture: tools-list.generated.json in this section’s source).
| Tool | What it does |
|---|---|
redact_text | Redacts text matching a regular expression and saves a redacted copy |
redact_image_area | Covers a rectangular page area with a solid box, hiding image content |
redact_annotations | Redacts or deletes annotations and comments |
erase_metadata | Erases metadata fields that carry identifying information |
get_document_info | Returns file type, page count, size, and per-page dimensions |
get_license_status | Reports the active licensing mode and, under metered licensing, consumption |
Every tool takes its document through the same file object — pass either a name from your storage folder or inline content:
{ "file": { "filePath": "case-file.pdf" } }
| Field | Type | Description |
|---|---|---|
filePath | string | File path or name in the configured storage folder |
fileContent | string | Base64-encoded file content (alternative to filePath) |
fileName | string | Original filename with extension — required with fileContent. Since 26.9.0 it also works on its own, resolved from the storage folder exactly like filePath |
You rarely write this JSON yourself: the AI agent does, from your plain-language prompt. Missing files are not an error to fear — the tool responds with the list of available files so the agent can correct itself.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
