mcpField
N
nuqs

nuqs

github.com/fandhe-aiDevelopment4100 installsUpdated 4d ago
Repository

About nuqs

A reference skill for nuqs, a React library that synchronizes URL query parameters with state as a type-safe alternative to React.useState. It maps tasks to documentation sections and provides guidance for finding relevant API details.

Key features

  1. 01Task-to-documentation category mapping
  2. 02Hook and parser references
  3. 03Framework adapter guidance
  4. 04Option and server-side API references
  5. 05Limits, samples, and script guidance

Use cases

  1. 01Look up useQueryState or useQueryStates
  2. 02Choose built-in or custom parsers
  3. 03Configure adapters for a React framework
  4. 04Find guidance on URL limits or server parsing

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/fandhe-ai/agent-reference-skills --skill nuqs

After installing, type/nuqsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/adapters/
adapters.md
README.md
references/guides/
README.md
seo.md
tips-tricks.md
troubleshooting.md
references/hooks/
README.md
useQueryState.md
useQueryStates.md
references/limits/
limits.md
README.md
references/options/
options.md
README.md
references/parsers/
built-in.md
community-effect-schema.md
community-sury.md
community-tanstack-table.md
community-zod-codecs.md
custom.md
README.md
references/server/
README.md
server-side.md
references/utilities/
createSerializer.md
createStandardSchemaV1.md
inferParserType.md
README.md
samples/
adapter-setup.md
array-params.md
basic-query-state.md
custom-parser.md

Details

From the project README

nuqs API リファレンス

nuqs — Type-safe URL query state management for React。 React.useState のドロップイン置換として URL クエリパラメータと状態を同期する。

対象 nuqs v2.10.2（2026-10-08、GitHub tag v2.10.2、docs 原本 packages/docs/content/docs at that tag）。

ディレクトリ構成

skills/nuqs/
  SKILL.md
  references/
    hooks/
      README.md
      useQueryState.md
      useQueryStates.md
    parsers/
      README.md
      built-in.md
      custom.md
      community-zod-codecs.md
      community-effect-schema.md
      community-sury.md
      community-tanstack-table.md
    adapters/
      README.md
      adapters.md
    guides/
      README.md
      troubleshooting.md
      seo.md
      tips-tricks.md
    options/
      README.md
      options.md
    server/
      README.md
      server-side.md
    utilities/
      README.md
      createSerializer.md
      createStandardSchemaV1.md
      inferParserType.md
    limits/
      README.md
      limits.md
  samples/
    README.md
    basic-query-state.md
    typed-state-with-parsers.md
    multiple-params-batch-update.md
    search-filter-debounce.md
    server-side-parsing.md
    search-params-cache.md
    adapter-setup.md
    custom-parser.md
    url-key-remapping.md
    array-params.md
    testing.md
    suspense-boundary.md
    seo-canonical-url.md
  scripts/
    README.md
    install.md
    setup.md
    testing.md
    debug.md

探索手順

タスクからカテゴリを引き、カテゴリの README.md で目的のページを特定する:

  1. 下記マッピング表でタスクに対応するカテゴリを探す
  2. そのカテゴリの references/{category}/README.md を参照して目的のページを特定する
  3. 該当ページの .md を Read して詳細を確認する

タスク → カテゴリ マッピング

タスクカテゴリ参照 README
useQueryState の基本的な使い方、単一パラメータの読み書きhooksreferences/hooks/README.md
useQueryStates でバッチ更新、複数パラメータの同期hooksreferences/hooks/README.md
ビルトインパーサー（parseAsString / parseAsInteger / parseAsBoolean / parseAsArrayOf 等）の使い方parsersreferences/parsers/README.md
createParser でカスタムパーサーを作成する、Zod codecs / Effect Schema / Sury / TanStack Table コミュニティパーサーparsersreferences/parsers/README.md
フレームワーク別 NuqsAdapter（Next.js app/pages/unified、React SPA、Remix、React Router v6/v7/v8、TanStack Router）、serverSearch、非推奨 adapteradaptersreferences/adapters/README.md
Suspense boundary エラー、同一 key の異なるパーサー、Pages Router SSR の null、canonical URL / SEO、カスタムフック再利用guidesreferences/guides/README.md
history, shallow, scroll, throttle, debounce, clearOnDefault, startTransition オプション設定optionsreferences/options/README.md
createLoader, createSearchParamsCache でサーバーサイド解析serverreferences/server/README.md
createSerializer, createStandardSchemaV1, inferParserType でパーサーからユーティリティを生成するutilitiesreferences/utilities/README.md
URL 長さ・ブラウザ制限（throttling, max URL length）を知りたいlimitsreferences/limits/README.md
典型的な使い方を知りたいsamplessamples/README.md
インストール・CLI コマンド・テスト・デバッグ手順を知りたいscriptsscripts/README.md

Comments

Markdown supported