CtrlK
BlogDocsLog inGet started
Tessl Logo

faiss

Facebook's library for efficient similarity search and clustering of dense vectors. Supports billions of vectors, GPU acceleration, and various index types (Flat, IVF, HNSW). Use for fast k-NN search, large-scale vector retrieval, or when you need pure similarity search without metadata. Best for high-performance applications.

62

Quality

74%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./backend/cli/skills/llm-tools/faiss/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

65%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A well-structured, highly actionable library guide with clean executable examples, but it wastes its reference bundle: index-type detail lives inline while references/index_types.md sits orphaned, and no end-to-end workflow (choose → train → search → verify recall) sequences the pieces.

Suggestions

Link the body's 'Index types' section to references/index_types.md (e.g., 'See [index_types.md](references/index_types.md) for the full selection guide') and cut the duplicated inline detail, which would fix both progressive disclosure and conciseness.

Add a short end-to-end workflow (choose index by dataset size → train → add → search → check recall) with a verification checkpoint such as comparing approximate vs. Flat results on a sample query.

Make code blocks self-contained or explicitly note variable definitions, since IVF/HNSW/PQ snippets depend on vectors, query, and k from the basic-usage section.

DimensionReasoningScore

Conciseness

Lean, code-first body with terse comments and no explanation of concepts Claude already knows; every section delivers runnable material. Not a 5 because the 'Metrics' star-count block, the Resources section with repeated GitHub stats, and the inline duplication of index-type content already in references/index_types.md could all be trimmed.

4 / 5

Actionability

Executable, copy-paste-ready snippets throughout: installation commands, IndexFlatL2 usage, IVF train/add/nprobe, HNSW, PQ, write_index/read_index, GPU conversion, and LangChain/LlamaIndex integrations. Minor gaps only — later snippets reuse variables (vectors, query, k, docs) defined only in earlier sections, so individual blocks aren't fully self-contained, matching the 4 anchor rather than 5.

4 / 5

Workflow Clarity

The body is organized as a catalog of features, not a sequenced workflow: there is no explicit 'choose index type → train → add → search → tune → save' progression, and checkpoints like verifying an index is trained or measuring recall before switching index types are absent. This fits the 3 anchor ('sequence present within code but checkpoints missing or implicit') — higher scores require explicit checkpoints, and there is no destructive/batch operation forcing a cap below 3.

3 / 5

Progressive Disclosure

Section headers are clear, but the bundle file references/index_types.md (280 lines, including a fuller index-selection table) is never linked from the body — the index-types section duplicates its content inline instead. This matches the 3 anchor ('references present but not clearly signaled; content that should be separate is inline'), and it cannot be a 4/5 while an existing reference goes unlinked and its material is inlined.

3 / 5

Total

14

/

20

Passed

Description

83%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description: concrete capability list plus an explicit 'Use for...' trigger clause that even distinguishes the no-metadata niche. Main weaknesses are a few missing natural synonyms (embeddings, semantic search) and a generic closing sentence that adds no information.

Suggestions

Add natural synonyms users actually say — 'embeddings', 'semantic search', 'vector database' — to the trigger clause for broader matching.

Drop the empty 'Best for high-performance applications' filler sentence; it duplicates what 'high throughput' use-cases already state.

DimensionReasoningScore

Specificity

Lists several concrete capabilities — 'similarity search and clustering of dense vectors', 'GPU acceleration', 'various index types (Flat, IVF, HNSW)', 'fast k-NN search, large-scale vector retrieval' — with only minor gaps (e.g., save/load and framework integrations unmentioned). Not a 5 because the trailing 'Best for high-performance applications' is generic filler and a couple of coverage gaps remain.

4 / 5

Completeness

Clearly answers 'what' ('efficient similarity search and clustering of dense vectors. Supports billions of vectors, GPU acceleration...') and 'when' with an explicit 'Use for fast k-NN search, large-scale vector retrieval, or when you need pure similarity search without metadata' trigger clause. Both halves are concrete, matching the 5 anchor; the 4 anchor ('when' could be more explicit) does not fit.

5 / 5

Trigger Term Quality

Good natural-term coverage: 'similarity search', 'k-NN search', 'vector retrieval', 'GPU acceleration', 'large-scale'. A few common user phrasings are missing (e.g., 'embeddings', 'semantic search', 'vector database', 'RAG'), keeping it below the comprehensive-synonym anchor at 5.

4 / 5

Distinctiveness Conflict Risk

Mostly distinct: 'pure similarity search without metadata' carves out a clear niche versus metadata-capable vector stores, and FAISS is a named specific library. Minor overlap risk remains with adjacent RAG/vector-store skills triggered by generic 'vector retrieval' phrasing, so it sits below the minimal-conflict 5 anchor.

4 / 5

Total

17

/

20

Passed

Validation

87%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

metadata_version

'metadata.version' is missing

Warning

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

14

/

16

Passed

Repository
synthetic-sciences/openscience
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.