What is redis-vl-python AGENTS.md?

A repository instruction file for agents working on RedisVL, a Python library for using Redis for vector search and related data tasks. It lists common installation, formatting, type-checking, linting, testing, Redis, documentation, and pre-commit commands.

Use it as guidance when installing, changing, testing, documenting, or committing code in the redis-vl-python repository.

An agent can otherwise run the wrong checks or overlook project conventions, such as matching synchronous and asynchronous APIs. These instructions give it the repository's expected workflow and architectural patterns.

How redis/redis-vl-python configures Codex and OpenCode

About the project

Redis Vector Library is a Python client for using Redis in AI applications, including vector search, embeddings, semantic caching, and memory for agents. It is used to build retrieval-augmented generation pipelines, recommendation systems, and other applications that search and manage AI-related data in Redis. The catalogue add-ons support its use through instructions and rules.

redis/redis-vl-python · 432 stars · on GitHub · docs.redisvl.com

Reuse

Borrowing it

Nothing to install: this file belongs to redis/redis-vl-python. 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/redis/redis-vl-python/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/redis/redis-vl-python

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/redis/redis-vl-python/agents-md/github.svg)](https://agentmods.dev/instructions/redis/redis-vl-python/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/redis/redis-vl-python/agents-md"><img src="https://agentmods.dev/badge/instructions/redis/redis-vl-python/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/redis/redis-vl-python/agents-md"><img src="https://agentmods.dev/badge/instructions/redis/redis-vl-python/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,693 This file is loaded in full into every session.

When invoked 1,693 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.

Model	Per session	Once invoked
Fable 5.1	$0.01693	$0.01693
Opus 5.5	$0.00677	$0.00677
Sonnet 5.5	$0.00339	$0.00339
Haiku 4.5	$0.00169	$0.00169

Measured 3d ago against content hash 01a0e2d0da16, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

redis-vl-python 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 3d 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 · 162 lines

How it starts

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

AGENTS.md

Guidance for coding agents working on RedisVL, whichever agent or model you are.

Frequently Used Commands

# Development workflow
make install          # Install dependencies
make format           # Format code (black + isort)
make check-types      # Run mypy type checking
make lint             # Run all linting (format + types)
make test             # Run tests (no external APIs)
make test-all         # Run all tests (includes API tests)
make check            # Full check (lint + test)

# Redis setup
make redis-start      # Start Redis container
make redis-stop       # Stop Redis container

# Documentation
make docs-build       # Build documentation
make docs-serve       # Serve docs locally

Pre-commit hooks are also configured, which you should run before you commit:

pre-commit run --all-files

Important Architectural Patterns

Async/Sync Dual Interfaces

Most core classes have both sync and async versions (e.g., SearchIndex / AsyncSearchIndex)
Follow existing patterns when adding new functionality

Schema-Driven Design

# Index schemas define structure
schema = IndexSchema.from_yaml("schema.yaml")
index = SearchIndex(schema, redis_url="redis://localhost:6379")

Critical Rules

Do Not Modify

CRITICAL: Do not change this line unless explicitly asked:

token.strip().strip(",").replace(""", "").replace(""", "").lower()

Protected Directories

CRITICAL: NEVER delete the local_docs/ directory or any files within it.

Git Operations

CRITICAL: NEVER use git push or attempt to push to remote repositories. The user will handle all git push operations.

Code Quality

IMPORTANT: Always run make format before committing code to ensure proper formatting and linting compliance.

README.md Maintenance

IMPORTANT: DO NOT modify README.md unless explicitly requested.

If you need to document something, use these alternatives:

Development info → CONTRIBUTING.md
API details → docs/ directory
Examples → docs/examples/
Project memory (explicit preferences, directives, etc.) → AGENTS.md (CLAUDE.md only imports this file)

Read the full file on GitHub · 162 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.

3d ago Changed · +1 lines · +80 tokens per session 01a0e2d0da16
10d ago First seen · 161 lines · 1,613 tokens per session scan A 7fd2272a7df6

Subscribe to this mod's changes

redis-vl-python AGENTS.md is an instructions file published in the GitHub repository redis/redis-vl-python (432 stars, last pushed today), licensed MIT. It adds 1,693 tokens to every session, about $0.0068 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-10-20.

Databases LLM Project management Python Redis and cache embedding large-language-models redis vector-database

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

redis-vl-python: Instructions file for Codex