Report · marked 25 Aug 2026

volcengine/OpenViking

An agent can work here, but it will waste turns finding its footing.

Python · 33,277 stars · 3,972 files · branch main

63 /100 B

Instructions 3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup 16/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and pinned runtime version.Verification loop 22/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Full marks.Context economy 11/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability 10/10How quickly anything new can orient itself. Full marks.

Higher is better. Accent marks what is costing you most.

Fix these first

Agent instruction file

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

File sizes fit in context

A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.

The full marking

Every deduction below names the file or setting it came from.

Instructions 3/27 F

Whether the repo tells an agent how to behave before it starts guessing.

✗Agent instruction file 0/12

None found. Every agent that opens this repo starts from zero.

Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.

Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules

✗Instruction quality 0/12

Nothing to judge, since there are no instructions.

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

✓README as an entry point 3/3

README has a clear getting-started section.

Setup 16/20 A-

Whether an agent can install the project and get it running without a human.

✓Deterministic install 6/6

uv.lock pins the dependency tree.

Found uv.lock

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

Makefile

pyproject.toml scripts

✗Environment config 2/4

Env vars are mentioned in the README but there's no example file to copy.

Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.

✗Pinned runtime version 0/2

No pinned runtime version.

Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.

✓Reproducible environment 2/2

dockerfile gives a known-good environment.

Verification loop 22/22 A+

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

✓Tests exist 8/8

1053 test files against 3074 source files.

e.g. .github/workflows/api_test.yml, .github/workflows/oc2ov_test.yml, agent-plugins/plugin.test.mjs

✓Test command is discoverable 7/7

An agent can find and run `pytest`.

✓Continuous integration 4/4

26 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

pyproject.toml encodes the house style.

–Static type checking n/a

Not applicable — the Rust compiler type checks every build.

Context economy 11/20 B-

Whether the repo fits in a context window, or fights it.

✓No committed build output 6/6

No generated directories committed.

✓.gitignore hygiene 3/3

.gitignore covers 158 patterns.

✗File sizes fit in context 0/6

20 source files are over 100KB.

A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.

third_party/croaring/roaring.c — 797KB

crates/ov_cli/src/config_wizard/wizard.rs — 281KB

crates/ragfs/src/git/service.rs — 257KB

✗Repository weight 2/5

About 259MB checked out. Large enough that cloning and searching are both slow.

Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md — drafted for volcengine/OpenViking

# AGENTS.md

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

## Setup

```
uv sync
```

## Commands

```
make help
make check-pip
make check-deps
make build          # produce a build
make clean
make build-studio
```

## Layout

- `tests/`       724 source files
- `openviking/`  621 source files
- `examples/`    450 source files
- `third_party/` 324 source files
- `web-studio/`  282 source files
- `bot/`         181 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/api_test.yml`.
- CI defines what passing means. See `.github/workflows/_build.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `third_party/croaring/roaring.c` is 797KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.

Open the raw markdown or curl -o AGENTS.md agentreadme.com/draft/volcengine/OpenViking.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

[![agent ready](https://agentreadme.com/badge/volcengine/OpenViking.svg)](https://agentreadme.com/volcengine/OpenViking)

Other Python repositories, marked

vinta/awesome-python 81 A- NousResearch/hermes-agent 84 A- TheAlgorithms/Python 66 B yt-dlp/yt-dlp 54 C+ Significant-Gravitas/AutoGPT 63 B microsoft/markitdown 46 C

All Python repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in