Skip to content
Skills Library
Documents & office · Learning & explanation

rossum-reference

/rossum-reference

Complete Rossum.ai platform reference including API, architecture, concepts, schemas, extensions, and workflows. Use when answering questions about Rossum, writing Rossum integrations, configuring queues/schemas/hooks, or working with the Rossum API.

Licence
MIT
Last repository change
27.10.2026

Assessment and security

90/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content25 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
3
Scripts
0
HTML comments
0
URLs in SKILL.md
1
Deprecation

No signals detected. Repository changed on 27.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Complete Rossum.ai platform reference including API, architecture, concepts, schemas, extensions, and workflows. Use when answering questions about Rossum, writing Rossum integrations, configuring queues/schemas/hooks, or working with the Rossum API.

Original author description

Complete Rossum.ai platform reference including API, architecture, concepts, schemas, extensions, and workflows. Use when answering questions about Rossum, writing Rossum integrations, configuring queues/schemas/hooks, or working with the Rossum API.

How it works

  1. Verification Rule (read first)
  2. Safety Rules
  3. Customer-facing terminology
  4. When to use
Original SKILL.md headings · 32 lines, 429 words
SKILL.md preview
---
name: rossum-reference
description: Complete Rossum.ai platform reference including API, architecture, concepts, schemas, extensions, and workflows. Use when answering questions about Rossum, writing Rossum integrations, configuring queues/schemas/hooks, or working with the Rossum API.
user-invocable: false
---

# Rossum.ai Platform Reference

This skill provides comprehensive reference documentation for the Rossum.ai document automation platform. For complete details, see [reference.md](reference.md).

Which Rossum API operations the `rossum-api` MCP server wraps is tracked in [api-coverage.md](api-coverage.md) (auto-generated). Read (GET) operations without a dedicated tool are still reachable through the generic `rossum_get` tool (shown as ✅ via rossum_get); ⬜ pending = an uncovered write with no MCP tool yet.

## Verification Rule (read first)

**Do not make assumptions. All technical decisions must be grounded in verified facts, and when uncertain you must ask before acting.** API endpoints, field names, hook events, and `operations` payloads must be verified against the official docs at <https://rossum.app/api/docs/openapi/guides/getting-started/#introduction> or a live read-only probe before being written into code or documentation. If you must guess, label the claim *Unverified — confirm before relying on this*. Full rationale in [`../__shared/verification-rules.md`](../__shared/verification-rules.md).

## Safety Rules

**Do not call write/mutating API tools without explicit user approval.** This applies to all `rossum_create_*`, `rossum_patch_*`, `rossum_delete_*` tools, all `data_storage` write tools (insert, update, delete, replace, bulk_write, drop), and `prd2 push`/`prd2 deploy` / `rdc sync` (without `--dry-run` or `--no-push`) commands. Read-only tools (list, get, find, aggregate, whoami) are fine without confirmation. When in doubt, describe what you intend to do and ask first.

**Edit local `.py` files, not JSON.** When modifying hook code or formula logic in a prd project, only edit the `.py` file. Never edit the `code` field in hook JSON or the `formula` property in `schema.json` — `prd2 push` syncs `.py` files into JSON automatically. Do not use `rossum_patch_hook` or `rossum_patch_schema` to push code changes that should go through `prd2 push` instead.

**Two deployment tools — detect which one the project uses.** `prd_config.yaml` at the root → **prd2** (see `prd-reference`). `rdc.toml` at the root → **rdc** (see `rdc-reference`): code lives in sidecar `.py` files the same way, but references are `rdc://<kind>/<slug>`, pull is `rdc sync <env> --no-push`, push is `rdc sync <env>` after a `--dry-run`, and promotion is `rdc migrate`. Never run one tool against the other's project.

## Customer-facing terminology

In SOWs, proposals, emails, and any other customer-facing material, write "Master Data Hub" in full — never "MDH" — and do not mention "Data Storage" (it is implementation; the product is Master Data Hub). Reference content and internal developer guidance can use "MDH" freely.

## When to use

Use this knowledge when:
- Answering questions about Rossum concepts, architecture, or features
- Writing code that integrates with the Rossum API
- Configuring schemas, queues, hooks, or connectors
- Debugging Rossum extension or webhook issues
- Explaining annotation lifecycles or document processing flows
Files in this package (3)
  • SKILL.md 3 KB
  • api-coverage.md 23 KB
  • reference.md 108 KB

Versions

The database has no other skills named rossum-reference.

Database snapshot: 13.11.2026 · package version c7496ff945ac (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100document
    Document a Rossum.ai implementation — produce a structured technical reference covering architecture, hooks, queues, integrations, formulas, and troubleshooting. Use this skill whenever the user wants to understand, describe, summarize, or write up what an implementation does.…
  • 100prd-reference
    prd2 CLI reference for managing Rossum configurations across environments. Covers pull, push, deploy, purge commands, credentials, deploy files, attribute overrides, and project structure. Use when working with prd2, deployment workflows, or Rossum environment management.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.