Command Palette

Search for a command to run...

UnylyUnyly
Весь каталог

Myst

БесплатноНе проверен

Enables searching any MyST Markdown or Jupyter Book documentation site that publishes a search index, without crawling or embeddings.

GitHubEmbed

Описание

Enables searching any MyST Markdown or Jupyter Book documentation site that publishes a search index, without crawling or embeddings.

README

myst-mcp is an MCP server for searching any MyST Markdown or Jupyter Book documentation site that publishes myst.search.json. It consumes the static search index that MyST already builds, so it does not crawl pages, host a backend, or require embeddings.

MyST is the document engine and Jupyter Book is a distribution of it. The myst.search.json index is produced at the MyST engine layer, which means this package works across book-theme, article-theme, custom themes, Jupyter Book, and plain mystmd sites.

Usage

npx -y myst-mcp <site-url-or-local-path> ["Human description of these docs"]

Examples:

npx -y myst-mcp https://your-myst-site.example "Example MyST docs"
{
  "mcpServers": {
    "my-docs": {
      "command": "npx",
      "args": ["-y", "myst-mcp", "https://your-myst-site.example", "Example MyST docs"]
    }
  }
}

Claude Code:

claude mcp add my-docs -- npx -y myst-mcp https://your-myst-site.example "Example MyST docs"

Tools

search_docs

Input:

{ "query": "installation", "limit": 10 }

Returns search hits with title, section, breadcrumb, absolute URL, snippet, type, and score.

fetch_page

Input:

{ "url": "/getting-started/" }

Returns the page title and LLM-friendly Markdown reconstructed from all matching search index records in document order. Full URLs and anchor URLs are accepted.

Supported sources

  • Remote MyST sites, loaded from <base>/myst.search.json
  • Local MyST site build directories containing myst.search.json
  • A direct local path to myst.search.json

The server requires MystSearchIndex version "1" and fails clearly if the file is missing, invalid, or from an unsupported future version.

Development

pnpm install
pnpm build
pnpm test

from github.com/eresearchqut/myst-mcp

Установка Myst

У этого сервера нет опубликованного пакета — он собирается из исходников. Открой репозиторий и следуй инструкции в README.

▸ github.com/eresearchqut/myst-mcp

FAQ

Myst MCP бесплатный?

Да, Myst MCP бесплатный — установка в пару кликов через Unyly без оплаты.

Нужен ли API-ключ для Myst?

Нет, Myst работает без API-ключей и переменных окружения.

Myst — hosted или self-hosted?

Self-hosted: сервер запускается локально на твоей машине командой из раздела установки.

Как установить Myst в Claude Desktop, Claude Code или Cursor?

Открой Myst на unyly.org, выбери вкладку своего клиента (Claude Desktop, Claude Code, Cursor) и нажми Install — конфиг сгенерируется автоматически, без правки JSON.

Похожие MCP

Compare Myst with

Не уверен что выбрать?

Найди свой стек за 60 секунд

Автор?

Embed-бейдж для README

Похожее

Все в категории development