AGENTS.md@clients/docsB

AGENTS.md@clients/docs from vellum-ai/vellum-assistant is an AGENTS.md file: the standing instructions coding agents read in that repo.

Install it, pinned
mdr add vellum-ai/vellum-assistant/clients/docs/AGENTS.md@git:20260904.e27a62c

Pins git:20260904.e27a62c in mdr.lock. Pin the fingerprint instead.

Audit grade
B, 13 of 14 checks passed
Kind
AGENTS.md file
Repository
vellum-ai/vellum-assistant
Path
clients/docs/AGENTS.md
Versions recorded
5
Latest version
git:20260904.e27a62c, committed Sep 4, 2026
First version recorded
Aug 4, 2026
Size
12,354 bytes
Repository stars
1,483
License
MIT

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# clients/docs: Agent Guidance

Applies to all code under `clients/docs/`. Subordinate to [`clients/AGENTS.md`](../AGENTS.md) and the root [`AGENTS.md`](../../AGENTS.md).

`@vellumai/docs` is the public docs site: an SSR Next.js app (standalone output) serving www.vellum.ai/docs. It is a member of the root bun workspace.

## URL rules: everything public lives under `/docs`

Ingress only routes `/docs/*` to this app. Every URL the app emits publicly MUST be `/docs`-prefixed:

- Pages are authored under `src/app/docs/` with no `basePath`.
- The search API is `/docs/api/search`, markdown mirrors are `/docs/<path>.md` (index: `/docs/index.md`), the agent index is `/docs/llms.txt`, the sitemap is `/docs/sitemap.xml`, and assets are served from `public/docs/`.
- Next's build assets are served under the prefix too: `assetPrefix: "/docs"` in `next.config.ts` plus the first `beforeFiles` rewrite (`/docs/_next/*` → `/_next/*`). Without both halves, stylesheets and scripts resolve to `/_next/*`, which ingress routes to a different backend. `verify-parity.ts` asserts asset subresources load.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add vellum-ai/vellum-assistant/clients/docs/AGENTS.md@sha256:dea7ebfd89acc5d7

The line at the top of this page pins the label git:20260904.e27a62c, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_4pnydcgocfxaaycq.svg)](https://markdownregistry.com/a/art_4pnydcgocfxaaycq)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 5 versions of this file, between Aug 4, 2026 and Sep 4, 2026, about one every 8 days. Its first recorded version is graded A and its latest B.

versioncommittedcommitsizeaudit
git:20260904.e27a62c latest2026-09-04 e27a62c 12,354 BB view · diff
git:20260902.2f9a4162026-09-02 2f9a416 11,675 BB view · diff
git:20260828.94de5122026-08-28 94de512 9,645 BA view · diff
git:20260804.a4176192026-08-04 a417619 9,645 BA view · diff
git:20260804.13c48e02026-08-04 13c48e0 9,676 BA view

Audit of the latest version

B  13 of 14 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • fail: No script tag (matched: <script)
  • pass: Size between 200 bytes and 200 KB (12354 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address

Starting a new one? Use a template for AGENTS.md on mdpantry, which passes every one of these checks and says what to change in it.

Source

GitHub

vellum-ai/vellum-assistant · 1,483 stars · license MIT · pushed 2026-11-08 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_4pnydcgocfxaaycq
GET https://markdownregistry.com/api/v1/resolve?ref=vellum-ai/vellum-assistant/clients/docs/AGENTS.md
GET https://markdownregistry.com/api/v1/blob/dea7ebfd89acc5d7b0d454b28e9f62a30e84064756a7497ee1ce8d022fbfa084

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: how to write a good AGENTS.md · AGENTS.md vs CLAUDE.md · which agent file does what.

More from vellum-ai/vellum-assistant

add-mcp-integration SKILL.md skill
vellum-ai/vellum-assistant · .claude/skills/add-mcp-integration/SKILL.md · Add a vendor's remote MCP server to the bundled integrations catalog (plugins/mcp-catalog/<name>/ +…
git:20260924.494829c · audit A · 1,483 stars
cli-testing SKILL.md skill
vellum-ai/vellum-assistant · .claude/skills/cli-testing/SKILL.md · Manually test a running Vellum assistant end-to-end purely from the CLI — no desktop app or web UI. Hatch an instance…
git:20260608.6985b64 · audit A · 1,483 stars
release SKILL.md skill
vellum-ai/vellum-assistant · .claude/skills/release/SKILL.md · Cut a new release: create the release branch (staging bake), then dispatch the production Release run on that branch.
git:20261001.80120c7 · audit A · 1,483 stars
update SKILL.md skill
vellum-ai/vellum-assistant · .claude/skills/update/SKILL.md · Restart the Vellum assistant and gateway services. Smart branch handling: pulls from main by default, restarts in-place…
git:20260616.1d51808 · audit A · 1,483 stars
e2e SKILL.md skill
vellum-ai/vellum-assistant · .claude/skills/vellum-skills/e2e/SKILL.md · Run end-to-end tests via the CI workflow.
git:20260317.23378c6 · audit A · 1,483 stars
vellum-boundary-guard SKILL.md skill
vellum-ai/vellum-assistant · .cursor/skills/vellum-boundary-guard/SKILL.md · Check Vellum Assistant architecture and package boundaries. Use when editing imports, moving code, adding endpoints…
git:20260521.b4bdd7a · audit A · 1,483 stars
vellum-change-review SKILL.md skill
vellum-ai/vellum-assistant · .cursor/skills/vellum-change-review/SKILL.md · Review Vellum Assistant code changes for correctness, repo-specific quality rules, security risks, and missing…
git:20260521.b4bdd7a · audit A · 1,483 stars
vellum-feature-flag-rollout SKILL.md skill
vellum-ai/vellum-assistant · .cursor/skills/vellum-feature-flag-rollout/SKILL.md · Guide Vellum Assistant feature flag changes and rollout hygiene. Use when adding, editing, reviewing, or documenting…
git:20260612.4834458 · audit A · 1,483 stars
vellum-migration-checklist SKILL.md skill
vellum-ai/vellum-assistant · .cursor/skills/vellum-migration-checklist/SKILL.md · Validate Vellum Assistant database and workspace migrations. Use when adding, editing, reviewing, or testing…
git:20260702.d65ff55 · audit A · 1,483 stars
vellum-pr-readiness SKILL.md skill
vellum-ai/vellum-assistant · .cursor/skills/vellum-pr-readiness/SKILL.md · Prepare Vellum Assistant branches for review by checking git hygiene, PR scope, tests, docs, migrations, Linear…
git:20260521.b4bdd7a · audit A · 1,483 stars
vellum-skill-authoring SKILL.md skill
vellum-ai/vellum-assistant · .cursor/skills/vellum-skill-authoring/SKILL.md · Author and review first-party Vellum skills in the repository. Use when editing files under skills/, assistant bundled…
git:20260521.b4bdd7a · audit A · 1,483 stars
vellum-test-selection SKILL.md skill
vellum-ai/vellum-assistant · .cursor/skills/vellum-test-selection/SKILL.md · Select focused verification commands for Vellum Assistant changes. Use when deciding what tests, typechecks, lints, or…
git:20260702.d65ff55 · audit A · 1,483 stars

Every file in vellum-ai/vellum-assistant

Browse by kind, by grade B, or by owner.