InkQuest

Official3 tools

by serendipityApe · TypeScript

Browse free InkQuest stories, openings, and HSK recommendations.

Model Context Protocol (MCP) Server: dev.inkquest/inkquest

The dev.inkquest/inkquest MCP server provides access to content for InkQuest, including free InkQuest stories, story openings, and HSK recommendations. It is designed to browse these materials via the server interface, using the provided description as the basis for what the service supports.

🛠️ Key Features

Browse free InkQuest stories
Browse InkQuest openings
Browse HSK recommendations

🚀 Use Cases

Finding and reviewing free InkQuest stories
Looking up specific story openings
Accessing HSK recommendations alongside InkQuest materials

⚡ Developer Benefits

Provides a single MCP server target for InkQuest-related browsing (stories, openings, HSK recommendations)
Keeps the scope limited to the catalog items described in the server metadata

⚠️ Limitations

No tool names, counts, or additional capabilities are provided in the available server data

Captured live from the server via tools/list.

list_stories

List free, public InkQuest stories. Each card has the title, level (HSK for Chinese, CEFR for English), genre, a short description, and the public reading URL https://inkquest.dev/stories/{id}. Optional filters: target_language (zh or en), hsk_level (Chinese stories only), and genre. Does not include subscriber-only scenes, withdrawn demos, or user-generated stories.

Parameters3

target_language	string	optional	Learning language: zh for Chinese stories, en for English stories.
hsk_level	any	optional	HSK band for Chinese stories. Use an integer 1-9 or a string like "HSK 4". Does not apply to English CEFR stories.
genre	string	optional	Genre or keyword, such as mystery, romance, xianxia, comedy, or science fiction. Case-insensitive.

Raw schema

{
  "type": "object",
  "properties": {
    "target_language": {
      "type": "string",
      "enum": [
        "zh",
        "en"
      ],
      "description": "Learning language: zh for Chinese stories, en for English stories."
    },
    "hsk_level": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1,
          "maximum": 9
        },
        {
          "type": "string",
          "pattern": "^(?:HSK\\s*)?[1-9]$"
        }
      ],
      "description": "HSK band for Chinese stories. Use an integer 1-9 or a string like \"HSK 4\". Does not apply to English CEFR stories."
    },
    "genre": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40,
      "description": "Genre or keyword, such as mystery, romance, xianxia, comedy, or science fiction. Case-insensitive."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_story_opening

Return the free opening scene of one public InkQuest story: plain text, pinyin or pronunciation and short glosses when the catalog has them, and the opening choices. Premium choices are labeled and their following scenes are omitted. Always includes the https://inkquest.dev/stories/{id} URL where the reader continues. Refuses unknown ids, withdrawn demos, locked stories, and user-generated stories. Never returns subscriber-only scene text.

Parameters1

story_id

string

required

Public catalog id from list_stories, such as before-the-rain-stops.

Raw schema

{
  "type": "object",
  "properties": {
    "story_id": {
      "type": "string",
      "maxLength": 80,
      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
      "description": "Public catalog id from list_stories, such as before-the-rain-stops."
    }
  },
  "required": [
    "story_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

recommend_story

Recommend up to three public InkQuest stories. Pass hsk_level (1-9 or "HSK 4") to rank Chinese stories by closeness to that band. Optional genre or interests (keywords such as mystery, romance, xianxia, sci-fi) boost matches. Optional target_language is zh or en. Each match includes a short reason and a https://inkquest.dev/stories/{id} link. Only free catalog stories are considered; subscriber-only scenes and user-generated stories are excluded.

Parameters4

hsk_level	any	optional	HSK band for Chinese stories. Use an integer 1-9 or a string like "HSK 4". Does not apply to English CEFR stories.
target_language	string	optional	Learning language: zh for Chinese stories, en for English stories.
genre	string	optional	Genre or keyword, such as mystery, romance, xianxia, comedy, or science fiction. Case-insensitive.
interests	string	optional	Free-text interests, such as "mystery, rainy city" or "sci-fi". Combined with genre.

Raw schema

{
  "type": "object",
  "properties": {
    "hsk_level": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1,
          "maximum": 9
        },
        {
          "type": "string",
          "pattern": "^(?:HSK\\s*)?[1-9]$"
        }
      ],
      "description": "HSK band for Chinese stories. Use an integer 1-9 or a string like \"HSK 4\". Does not apply to English CEFR stories."
    },
    "target_language": {
      "type": "string",
      "enum": [
        "zh",
        "en"
      ],
      "description": "Learning language: zh for Chinese stories, en for English stories."
    },
    "genre": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40,
      "description": "Genre or keyword, such as mystery, romance, xianxia, comedy, or science fiction. Case-insensitive."
    },
    "interests": {
      "description": "Free-text interests, such as \"mystery, rainy city\" or \"sci-fi\". Combined with genre.",
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

README.md5 KBView on GitHub

InkQuest

Interactive language-learning fiction built with Next.js, Supabase, and OpenNext Cloudflare.

Getting Started

Install dependencies and run the development server:

bash

pnpm install
pnpm dev

Open http://localhost:3000.

Generated Stories Foundation

The first cloud-generation foundation includes:

Supabase credit ledger, reservations, story graph, jobs, outbox, billing tables, and RLS in supabase/migrations/202608220001_generated_story_billing.sql.
Server-created Lemon Squeezy checkouts and idempotent webhook processing.
Authenticated quote and generated-story job creation APIs.
Cloud adapter contracts and a reusable scene enrichment core in tools/story-pipeline/src/core.

Required server environment variables:

text

NEXT_PUBLIC_SUPABASE_URL
NEXT_PUBLIC_SUPABASE_ANON_KEY
NEXT_PUBLIC_GOOGLE_CLIENT_ID
SUPABASE_SERVICE_ROLE_KEY
NEXT_PUBLIC_SITE_URL

LEMONSQUEEZY_API_KEY
LEMONSQUEEZY_STORE_ID
LEMONSQUEEZY_WEBHOOK_SECRET
LEMONSQUEEZY_SUBSCRIPTION_VARIANT_ID
LEMONSQUEEZY_SUBSCRIPTION_CREDIT_GRANT
LEMONSQUEEZY_CREDIT_PACK_VARIANT_ID
LEMONSQUEEZY_CREDIT_PACK_GRANT

GENERATION_PRICING_VERSION
GENERATION_OPENING_TEXT_CREDITS
GENERATION_OPENING_TTS_CREDITS
GENERATION_SCENE_TEXT_CREDITS
GENERATION_SCENE_TTS_CREDITS

NEXT_PUBLIC_GOOGLE_CLIENT_ID is the Web OAuth client ID from Google Cloud. Add each deployed site origin (including local development) to its authorized JavaScript origins, and enable Google provider in Supabase.

Credit-pack variables are optional until that product is enabled. Generation pricing falls back to 20 credits for opening text, 10 for opening TTS, 12 for scene text, and 6 for scene TTS when the corresponding environment variables are missing or invalid. TTS pricing is required only when every_scene is offered. Never expose the service-role key, Lemon API key, or webhook secret through a NEXT_PUBLIC_ variable.

Apply the migrations in filename order. Existing environments that already ran the first two migrations should next apply supabase/migrations/202608230001_generated_story_tts.sql; it creates the private audio bucket and adds independent TTS commit/retry/refund transactions.

The generation execution path is:

text

Next.js → inkquest-generation Queue → generation-dispatcher → Cloud Run story-pipeline Worker

Additional main-app variables:

text

GENERATION_DISPATCH_SECRET
GENERATED_AUDIO_BUCKET

Cloud Run Worker variables:

text

SUPABASE_URL
SUPABASE_SERVICE_ROLE_KEY
GENERATION_WORKER_TOKEN
LLM_CHAT_COMPLETIONS_URL
LLM_API_KEY
LLM_MODEL
LLM_PROMPT_VERSION
TENCENT_SECRET_ID
TENCENT_SECRET_KEY
TENCENT_REGION
TENCENT_TTS_VOICE
AZURE_SPEECH_KEY
AZURE_SPEECH_REGION
AZURE_TTS_VOICE_ZH
AZURE_TTS_VOICE_EN
STORY_TTS_ZH_PROVIDER
STORY_TTS_EN_PROVIDER
GENERATED_AUDIO_BUCKET

GENERATED_AUDIO_BUCKET defaults to generated-audio. Configure the Azure Speech key and region on the Cloud Run Worker; the verified evaluation resource uses eastasia. Azure is preferred for both Chinese and English when configured, with zh-CN-Xiaoxiao:DragonHDFlashLatestNeural and en-US-JennyNeural as defaults. Set STORY_TTS_ZH_PROVIDER or STORY_TTS_EN_PROVIDER to azure or tencent to override selection. The Worker image also installs FFmpeg to normalize multi-part Tencent audio into one seekable MP3 before upload.

Create inkquest-generation and inkquest-generation-dlq in Cloudflare, deploy the main app, then deploy tools/generation-dispatcher/wrangler.jsonc. Configure GENERATION_WORKER_URL on the dispatcher and store GENERATION_WORKER_TOKEN with wrangler secret put.

For local development, start the Worker in a separate terminal before generating a story:

bash

PORT=8080 pnpm --filter @inkquest/story-pipeline worker:start

The Next.js development server dispatches new jobs to http://127.0.0.1:8080 by default. Set GENERATION_WORKER_URL to override it, and make sure Next.js and the Worker use the same GENERATION_WORKER_TOKEN.

Call POST /api/internal/generation/outbox every minute with Authorization: Bearer <GENERATION_DISPATCH_SECRET> to recover failed queue publications and expired Worker leases.

MCP

A read-only Model Context Protocol server for the public story catalog is served at /api/mcp (Streamable HTTP). It lists free stories, returns the opening scene, and recommends matches, each with an https://inkquest.dev/stories/{id} link. It does not expose generated stories or premium scenes. Setup, local checks, and registry publishing are in docs/mcp.md.

Validation

bash

pnpm exec tsc --noEmit
pnpm --filter @inkquest/story-pipeline typecheck
pnpm lint
pnpm build

Deployment uses OpenNext Cloudflare; see wrangler.jsonc and the preview / deploy scripts in package.json.

Install

Tools (3)

list_storiesget_story_openingrecommend_story

Remote endpoint

Streamable HTTP

Hosted server - connect over the network, no local install.

url

https://inkquest.dev/api/mcp

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "inkquest": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://inkquest.dev/api/mcp"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.

Model Context Protocol (MCP) Server: dev.inkquest/inkquest

🛠️ Key Features

🚀 Use Cases

⚡ Developer Benefits

⚠️ Limitations

list_stories

get_story_opening

recommend_story

InkQuest

Getting Started

Generated Stories Foundation

MCP

Validation

Install

Remote endpoint

Related servers