Practical overview
When it fits
Use TopK when an AI application needs a retrieval layer that can combine vector and keyword search, filter on metadata, or apply custom ranking to collection results.
Who it is for
- Developers building retrieval-augmented generation (RAG) backends.
- Teams creating document-search services that need multiple retrieval methods.
- Developers integrating retrieval through Python, JavaScript/TypeScript, Rust, SQL or a CLI.
Documented uses
- Store and query vector embeddings and metadata in collections.
- Retrieve documents with vector, BM25 keyword or hybrid search.
- Filter search results by metadata and apply custom ranking expressions.
- Connect a PostgreSQL client through the SQL interface.
- Use a coding-agent skill covering TopK schema design, chunking and hybrid queries.
Requirements & limits
- The repository identifies Rust as the primary language and the project as MIT-licensed and open source.
- Available integration routes include Python, JavaScript/TypeScript and Rust SDKs, SQL connectivity for PostgreSQL clients, and a CLI.
- A repository-provided coding-agent skill covers schema design, chunking, hybrid queries and multi-tenancy; it is a development aid, distinct from the retrieval service.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install the TopK skill for a coding agent
Add the TopK skill to a coding-agent environment so it can reference guidance on schema design, chunking, hybrid queries, and multi-tenancy.
Before you start
- Claude Code, Cursor, Codex, or another coding agent
- The
npxcommand
Steps
Run the command below.
npx skills add topk-io/topk --skill topkUse the installed skill as coding guidance for TopK schema design, chunking, hybrid queries, and multi-tenancy.
Expected outcome
The TopK skill is installed for the coding agent to consult when writing TopK code.
Guide limitations
- The instructions describe installing a coding-agent skill, not configuring a TopK service or executing retrieval queries.
- The skill is described as covering common mistakes, but specific procedures for using it are not given.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 13 October 2026
- Original website title
- topk-io/topk · Official homepage title · retained in its source language

