About ov-add-paper
A workflow skill for converting research papers into structured OpenViking resources. It guides agents through full-paper review, artifact compilation, validation, ingestion, and verification.
Key features
- 01Compile papers into structured artifacts
- 02Include figures, tables, and evidence
- 03Validate artifacts with a script
- 04Ingest through the OV CLI
- 05Verify the resulting resource
Use cases
- 01Prepare a local PDF for OpenViking
- 02Convert a paper URL into a resource
- 03Check artifact structure before ingestion
- 04Verify an ingested paper's target
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ volcengine/ openviking --skill ov-add-paperAfter installing, type/ov-add-paperin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
references/ara-compiler-profile.mdopenviking-ingest.mdscripts/validate_ara.pyDetails
From the project READMEov-add-paper
Goal
Turn a research paper into an OpenViking-ready structured resource, then complete ingestion with ov add-resource. The job is not done until the generated artifact directory has been validated and submitted to OpenViking.
Inputs
- Required: a paper source, usually a local PDF path or paper URL.
- Optional: output directory, OpenViking target URI, domain notes, related repo/source files, and whether to wait for OV processing.
- If the paper source is missing or inaccessible, ask for it before starting.
Workflow
- Read the paper completely, including appendices and all numbered figures/tables.
- Compile an ARA-style artifact directory using
references/ara-compiler-profile.md. - Validate the artifact with
scripts/validate_ara.py. - Fix validation failures unless the user explicitly accepts them.
- Ingest the validated artifact directory with
ov add-resourcedirectly. - Confirm the target with
ov stat/ov treeand return the artifact path, OV target/root URI, validation result, ingest result, and any unresolved gaps.
Output Contract
The generated artifact must include:
PAPER.mdlogic/problem.md,logic/claims.md,logic/concepts.md,logic/experiments.md,logic/related_work.mdlogic/solution/constraints.mdsrc/environment.mdtrace/exploration_tree.yamlevidence/README.md- Markdown plus PNG evidence files for every filed numbered table and figure
The final response must include the ov add-resource command result, or the recovery checks proving the target landed despite a broken --wait, or the exact blocker that prevented ingestion.
Verification
Run from this skill directory, or use an absolute path to the validator:
python3 scripts/validate_ara.py <artifact-dir>
Then ingest with the OV CLI:
ov add-resource <artifact-dir> --to viking://resources/papers/<slug> --wait
Before ingest, use ov -o json stat <target-uri> to check whether the target already exists. After ingest, verify with ov -o json stat <target-uri> and ov tree <target-uri>.
Permissions
- Writing a new OpenViking resource is allowed when the user asked to add or ingest the paper.
- Ask before intentionally reusing a target URI that may overwrite or replace an existing resource.
--skip-validationmay be used only when the user explicitly accepts the listed validation errors.
Boundaries
- Do not use
ov add-skill; this skill creates paper resources, not OV skills. - Do not silently skip
ov add-resource; if ingestion fails, report the command, error, and recovery path. - If
ov add-resource --waitexits with a connection error after creating the target, do not immediately retry the same URI. Runov stat,ov wait,ov observer queue, andov treeto determine whether ingestion completed. - Do not invent claims, evidence, source refs, code, numbers, or research history.
- Do not overwrite an explicit existing OV target unless the user asked for that target.
- Mark unsupported or unreadable content as unavailable instead of filling it in.
Runtime Resources
- Load
references/ara-compiler-profile.mdbefore compiling the artifact. - Load
references/openviking-ingest.mdbefore running OV ingestion or debugging an ingestion failure. - Use
scripts/validate_ara.pyfor deterministic checks.