DataShield Ontology · documentation
DataShield Ontology — Documentation
Verbose, code-measured documentation for the DataShield Ontology (the Library at library.myorg.ai): the governed data plane that AI agents, developers, analysts and governance teams work through. Every capability statement on these pages was measured against the source tree at v0.22.188 (tag 2b5f46a9) on 2026-09-22 and cites the file and line it came from, so a reader can re-verify any claim rather than trust it. Where the code and a standard or plan disagree, the page says so instead of describing the intent as if it were shipped.
Pages
Read in order for a full picture, or jump to the area you need.
DataShield Ontology: Overview and Architecture
*Measured against the tree at v0.22.188 (package.json), 2026-09-22. Read-only pass; every capability claim below carries a file:line citation or names the measured source it was taken from. Normative keywords (MUST, MUST NOT, SHOULD, MAY) a
Data Catalog
Measured from the codebase at v0.22.188 (2026-09-22). Every claim cites file:line; where a claim is inferred rather than read, it says so. Audience: developers, governance teams, analysts and AI agents driving the data_catalog umbrella.
Connectors: connection paths, the connection umbrella, and the dialable kinds
*Measured against /home/datashield/library at v0.22.188 (tag 2b5f46a9c, 2026-09-21). Every claim below carries a file:line you can re-read; where a value was obtained by evaluating the config module under tsx rather than by reading a litera
Datasets, Analysis and Transforms
Measured against: /home/datashield/library at v0.22.188 (package.json:3), 2026-09-22. Audience: developers, analysts, AI agents routing through the MCP surface. Method: every claim below is read from code or migrations and cited file:line.
Governance and Privacy
Measured against: /home/datashield/library at v0.22.188 (read-only pass, 2026-09-22). Audience: data-governance and privacy teams, developers, and AI agents driving the MCP surface. How to read this document: every claim carries a file:line
Development & Operations
Audience: developers and operators of the Library (v0.22.188, package.json). Method: every claim below was measured from the code or the governing document in this tree on 2026-09-22, cited as file:line. Where something is a plan rather t
Agent Guide: Integrating with the Library over MCP
Audience: AI agents and developers integrating via MCP (Model Context Protocol / JSON-RPC). Measured against: v0.22.188 — docs/versions/v0.22.188/capability-manifest.json (45 tools, 462 commands, describe coverage 0.89) and docs/versions/v0
How to read this set
- New to the platform: start with the overview, then the data catalog. Together they explain the one processing chain (providers → connections → crawlers → assets → bindings → datasets → analysis → transforms → publish) and which MCP umbrella owns each stage.
- Connecting a source: read the connectors page for the two connection paths, the credential shape per kind, what discover, profile and extract do, and the typed refusals a dial can return.
- Working with data: the datasets page covers ingest, the analysis engines, derivative datasets, the declarative transform model and what it does and does not materialise.
- Governance and privacy teams: the governance page renders STANDARD-009 in plain language, then the classification kernel, masking posture, stewardship, MDM and the evidence surfaces.
- Operating or contributing: the development page documents the job system, the release process as it actually runs, the gate chain, the bug registry and the Development section roadmap.
- Building an agent: the agent guide gives the first call, tiers, the error envelope, every umbrella grouped by task, and seven task recipes.
Conventions
- RFC 2119 keywords (MUST, SHOULD, MAY) carry their normative meaning.
- Timestamps are RFC 3339; durations are ISO 8601.
- A
file:linein backticks is a citation into the Library source tree at the stated release. - A capability is labelled
real,simulator,hardcoded,stuborabsentper STANDARD-005 §13; onlyrealmeans it runs in production today. - Items marked PLANNED or DESIGN are not shipped.
For AI assistants and search tools
Every page is also served as raw Markdown at its own URL plus .md, and the set is listed in the site's llms.txt and sitemap. The pages are self-contained: an agent that reads one page has the vocabulary and the command names it needs for that area without loading the others.
Maintaining these pages
The source of truth is this directory in the Library repository (docs/ontology-documentation/). The public site imports it with node site/tools/import-docs.mjs (configuration in the site's docs-import.config.json) followed by the site build; a page whose measured release is superseded should be re-measured and re-imported rather than edited in place on the site.
Raw Markdown index: /ontology/documentation.md.
You've seen the proof
Ready for a number? Scope your deployment and we'll price it against your own economics.
Get your quote →