surreal-skills: Instructions file for Codex

AGENTS.md

surreal-skills AGENTS.md is an instructions file for Codex, OpenCode from 24601/surreal-skills. It costs 7,386 tokens per session, scanned A, original, MIT.

Development instructions for a SurrealDB agent briefing and its command-line helper scripts. SurrealDB is a database, and the briefing exposes checks and commands for inspecting its setup and structure.

In plain words
What is it for?
Running health checks, verifying configuration, listing or inspecting tables, exporting a database schema, and retrieving the agent's capabilities manifest.
Why use it?
It gives agents a predictable way to check connectivity and versions before work and to inspect existing tables, fields, indexes, and events.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is 24601/surreal-skills's own configuration. It tells Codex and OpenCode how to work on surreal-skills itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything surreal-skills configures →

Reuse

Borrowing it

Nothing to install: this file belongs to 24601/surreal-skills. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/24601/surreal-skills/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/24601/surreal-skills

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for surreal-skills AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/24601/surreal-skills/agents-md/github.svg)](https://agentmods.dev/instructions/24601/surreal-skills/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/24601/surreal-skills/agents-md"><img src="https://agentmods.dev/badge/instructions/24601/surreal-skills/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for surreal-skills AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/24601/surreal-skills/agents-md"><img src="https://agentmods.dev/badge/instructions/24601/surreal-skills/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 7,386 This file is loaded in full into every session.
When invoked 7,386 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.07386 $0.07386
Opus 5.5 $0.02954 $0.02954
Sonnet 5.5 $0.01477 $0.01477
Haiku 4.5 $0.00739 $0.00739

Measured 1mo ago against content hash 01596ee913c5, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

surreal-skills AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 582 lines

How it starts

The opening of the file, as written. The whole thing — 582 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Agent Briefing: surrealdb

Structured reference for AI agents. Minimal prose, maximum signal.

Quick Start

# Check if configured
uv run {baseDir}/scripts/onboard.py --check

# Get full capabilities manifest (JSON)
uv run {baseDir}/scripts/onboard.py --agent

Capabilities

Command Script What It Does When to Use
doctor scripts/doctor.py Health check: CLI, connectivity, version, storage First run, troubleshooting, verifying environment
doctor --check scripts/doctor.py Quick pass/fail (exit code only) CI pipelines, pre-flight checks
schema introspect scripts/schema.py Full schema dump (tables, fields, indexes, events) Understanding existing database structure
schema tables scripts/schema.py List tables with field counts and indexes Quick overview of database contents
schema table <name> scripts/schema.py Inspect a single table in detail Debugging a specific table definition
schema export scripts/schema.py Export schema as SurrealQL or JSON Reproducible deployments, version control
onboard --agent scripts/onboard.py JSON capabilities manifest Agent self-discovery, integration setup
onboard --check scripts/onboard.py Verify prerequisites First run, CI

Decision Trees

"User wants to create a SurrealDB project"

1. Run doctor to verify environment:
   uv run {baseDir}/scripts/doctor.py

2. Is surreal CLI installed?
   NO  -> brew install surrealdb/tap/surreal (or see https://surrealdb.com/install)
   YES -> Continue

3. Choose storage engine (LOCAL DEV -- use scoped credentials in production):
   Development     -> surreal start memory --user root --pass root
   Single-node     -> surreal start rocksdb://data/mydb.db --user root --pass root
   Time-travel     -> surreal start surrealkv://data/mydb --user root --pass root
   Distributed     -> surreal start tikv://... --user root --pass root

4. Design schema:
   -> Reference rules/data-modeling.md for table/field patterns
   -> Reference rules/graph-queries.md if domain has relationships
   -> Reference rules/vector-search.md if semantic search needed

5. Apply schema (local dev credentials -- use scoped users in production):
   surreal import --endpoint $SURREAL_ENDPOINT --user root --pass root \
     --ns <ns> --db <db> schema.surql

6. Verify:
   uv run {baseDir}/scripts/schema.py introspect

Read the full file on GitHub · 582 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago First seen · 582 lines · 7,386 tokens per session scan A 01596ee913c5

Subscribe to this mod's changes

surreal-skills AGENTS.md is an instructions file published in the GitHub repository 24601/surreal-skills (35 stars, last pushed 4mo ago), licensed MIT. It adds 7,386 tokens to every session, about $0.0295 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

plan-forge caching.instructions.md

Caching patterns for .NET — IDistributedCache, Redis, in-memory, cache-aside, TTL strategies.

srnichols/plan-forge · 733 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens