mcpField
U
upstash-search-js

upstash-search-js

github.com/upstashData & databases341.3k installsUpdated 1d ago
Repository

About upstash-search-js

upstash-search-js is a documentation skill for developers using the Upstash Search TypeScript SDK. It covers indexing, document updates, search, and filtering, with references to SDK commands and an end-to-end setup workflow.

Key features

  1. 01TypeScript SDK setup guidance
  2. 02Document upsert and deletion
  3. 03Search and range queries
  4. 04Metadata and content handling
  5. 05SQL-like and structured filters

Use cases

  1. 01Indexing documents for search
  2. 02Searching documents with optional reranking
  3. 03Filtering results by metadata

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/upstash/skills --skill upstash-search-js

After installing, type/upstash-search-jsin Claude Code to confirm it loaded.

Bundled filesquick-start.mdsdk-overview.md

Details

From the project README

Upstash Search Documentation

Bundled docs and source

Before writing or debugging SDK code, check node_modules/@upstash/search/docs/ for bundled docs and node_modules/@upstash/search/src/ for readable TypeScript source. Read and search the relevant files when present; otherwise use the references in this skill.

Quick Start

Install the TS SDK:

npm install @upstash/search

Create a client and perform a simple upsert + search:

import { Search } from "@upstash/search";

const client = new Search({ url: process.env.UPSTASH_SEARCH_REST_URL, token: process.env.UPSTASH_SEARCH_REST_TOKEN });
const index = client.index("my-index");

await index.upsert({ id: "1", content: { text: "hello world" } });
const results = await index.search({ query: "hello" });

Basic steps:

  • Create an index
  • Insert or update documents
  • Run searches or filtered queries

Other Skill Files

sdk-overview

Provides detailed documentation for all TypeScript SDK commands. Includes:

  • delete: Deleting documents
  • fetch: Retrieving a document
  • info: Index info
  • range: Range queries
  • reset: Clearing an index
  • search: Search queries
  • upsert: Adding/updating documents
  • getting-started: Setup steps for the SDK
quick-start

Provides a fast, end-to-end workflow for creating a Search database, adding documents, and querying them. Covers essential concepts including:

  • Creating a database and storing credentials
  • Adding documents with content and metadata
  • Understanding content vs metadata (searchability and filterability)
  • Performing searches with optional reranking
  • Filtering syntax with SQL-like or structured filters
  • Common pitfalls and best practices

Comments

Markdown supported