Merge branch 'main' into llms-txt

Author: paoloricciuti

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+	"changelog": ["@svitejs/changesets-changelog-github-compact", { "repo": "sveltejs/mcp" }],
+	"commit": false,
+	"fixed": [],
+	"linked": [],
+	"access": "public",
+	"baseBranch": "main",
+	"updateInternalDependencies": "patch",
+	"ignore": []
+}

.github/workflows/check.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10
+          version: 10.17.1
 
       - name: Setup Node.js
         uses: actions/setup-node@v4

.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10
+          version: 10.17.1
 
       - name: Setup Node.js
         uses: actions/setup-node@v4

.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+permissions: {}
+
+jobs:
+  release:
+    permissions:
+      contents: write # to create release (changesets/action)
+      id-token: write # OpenID Connect token needed for provenance
+      pull-requests: write # to create pull request (changesets/action)
+    # prevents this action from running on forks
+    if: github.repository == 'sveltejs/mcp'
+    name: Release
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        # pseudo-matrix for convenience, NEVER use more than a single combination
+        node: [24]
+        os: [ubuntu-latest]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v5
+        with:
+          # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
+          fetch-depth: 0
+      - uses: actions/setup-node@v5
+        with:
+          node-version: ${{ matrix.node }}
+          package-manager-cache: false # pnpm is not installed yet
+      - name: install pnpm
+        shell: bash
+        run: |
+          PNPM_VER=$(jq -r '.packageManager | if .[0:5] == "pnpm@" then .[5:] else "packageManager in package.json does not start with pnpm@\n" | halt_error(1)  end' package.json)
+          echo installing pnpm version $PNPM_VER
+          npm i -g pnpm@$PNPM_VER
+      - uses: actions/setup-node@v5
+        with:
+          node-version: ${{ matrix.node }}
+          package-manager-cache: true # caches pnpm via packageManager field in package.json
+      - name: install
+        run: pnpm install --frozen-lockfile --prefer-offline --ignore-scripts
+      - name: build
+        run: pnpm run --filter ./packages/mcp-stdio/ build
+
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        # pinned for security, always review third party action code before updating
+        uses: changesets/action@e0145edc7d9d8679003495b11f87bd8ef63c0cba # v1.5.3
+        with:
+          # This expects you to have a script called release which does a build for your packages and calls changeset publish
+          publish: pnpm release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 10
+          version: 10.17.1
 
       - name: Setup Node.js
         uses: actions/setup-node@v4

apps/mcp-remote/src/hooks.server.ts

@@ -1,7 +1,19 @@
 import { http_transport } from '$lib/mcp/index.js';
 import { db } from '$lib/server/db/index.js';
+import { redirect } from '@sveltejs/kit';
 
 export async function handle({ event, resolve }) {
+	if (event.request.method === 'GET') {
+		const accept = event.request.headers.get('accept');
+		if (accept) {
+			const accepts = accept.split(',');
+			if (!accepts.includes('text/event-stream')) {
+				// the request it's a browser request, not an MCP client request
+				// it means someone probably opened it from the docs...we should redirect to the docs
+				redirect(302, 'https://svelte.dev/docs/mcp/overview');
+			}
+		}
+	}
 	const mcp_response = await http_transport.respond(event.request, {
 		db,
 	});

documentation/docs/10-introduction/10-overview.md

@@ -0,0 +1,44 @@
+---
+title: Overview
+---
+
+The Svelte MCP ([Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro)) server can help your LLM or agent of choice write better Svelte code. It works by providing documentation relevant to the task at hand, and statically analysing generated code so that it can suggest fixes and best practices.
+
+## Setup
+
+The setup varies based on the version of the MCP you prefer — remote or local — and your chosen MCP client (e.g. Claude Code, Codex CLI or GitHub Copilot):
+
+- [local setup](local-setup) using `@sveltejs/mcp`
+- [remote setup](remote-setup) using `https://mcp.svelte.dev/mcp`
+
+## Usage
+
+To get the most out of the MCP server we recommend including the following prompt in your `AGENTS.md` (or `CLAUDE.md`, if using Claude Code). This will tell the LLM which tools are available and when it's appropriate to use them.
+
+```md
+You are able to use the Svelte MCP server, where you have access to comprehensive Svelte 5 and SvelteKit documentation. Here's how to use the available tools effectively:
+
+## Available MCP Tools:
+
+### 1. list-sections
+
+Use this FIRST to discover all available documentation sections. Returns a structured list with titles, use_cases, and paths.
+When asked about Svelte or SvelteKit topics, ALWAYS use this tool at the start of the chat to find relevant sections.
+
+### 2. get-documentation
+
+Retrieves full documentation content for specific sections. Accepts single or multiple sections.
+After calling the list-sections tool, you MUST analyze the returned documentation sections (especially the use_cases field) and then use the get-documentation tool to fetch ALL documentation sections that are relevant for the user's task.
+
+### 3. svelte-autofixer
+
+Analyzes Svelte code and returns issues and suggestions.
+You MUST use this tool whenever writing Svelte code before sending it to the user. Keep calling it until no issues or suggestions are returned.
+
+### 4. playground-link
+
+Generates a Svelte Playground link with the provided code.
+After completing the code, ask the user if they want a playground link. Only call this tool after user confirmation and NEVER if code was written to files in their project.
+```
+
+If your MCP client supports it, we also recommend using the [svelte-task](prompts#svelte-task) prompt to instruct the LLM on the best way to use the MCP server.

documentation/docs/10-introduction/index.md

@@ -0,0 +1,3 @@
+---
+title: Introduction
+---

documentation/docs/20-setup/20-local-setup.md

@@ -0,0 +1,113 @@
+---
+title: Local setup
+---
+
+The local (or stdio) version of the MCP server is available via the [`@sveltejs/mcp`](https://www.npmjs.com/package/@sveltejs/mcp) npm package. You can either install it globally and then reference it in your configuration or run it with `npx`:
+
+```bash
+npx -y @sveltejs/mcp
+```
+
+Here's how to set it up in some common MCP clients:
+
+## Claude Code
+
+To include the local MCP version in Claude Code, simply run the following command:
+
+```bash
+claude mcp add -t stdio -s [scope] svelte npx -y @sveltejs/mcp
+```
+
+The `[scope]` must be `user`, `project` or `local`.
+
+## Claude Desktop
+
+In the Settings > Developer section, click on Edit Config. It will open the folder with a `claude_desktop_config.json` file in it. Edit the file to include the following configuration:
+
+```json
+{
+	"mcpServers": {
+		"svelte": {
+			"command": "npx",
+			"args": ["-y", "@sveltejs/mcp"]
+		}
+	}
+}
+```
+
+## Codex CLI
+
+Add the following to your `config.toml` (which defaults to `~/.codex/config.toml`, but refer to [the configuration documentation](https://github.com/openai/codex/blob/main/docs/config.md) for more advanced setups):
+
+```toml
+[mcp_servers.svelte]
+command = "npx"
+args = ["-y", "@sveltejs/mcp"]
+```
+
+## Gemini CLI
+
+To include the local MCP version in Gemini CLI, simply run the following command:
+
+```bash
+gemini mcp add -t stdio -s [scope] svelte npx -y @sveltejs/mcp
+```
+
+The `[scope]` must be `user`, `project` or `local`.
+
+## OpenCode
+
+Run the command:
+
+```bash
+opencode mcp add
+```
+
+and follow the instructions, selecting 'Local' under the 'Select MCP server type' prompt:
+
+```bash
+opencode mcp add
+
+┌  Add MCP server
+│
+◇  Enter MCP server name
+│  svelte
+│
+◇  Select MCP server type
+│  Local
+│
+◆  Enter command to run
+│  npx -y @sveltejs/mcp
+```
+
+## VS Code
+
+- Open the command palette
+- Select "MCP: Add Server..."
+- Select "Command (stdio)"
+- Insert `npx -y @sveltejs/mcp` in the input and press `Enter`
+- When prompted for a name, insert `svelte`
+- Select if you want to add it as a `Global` or `Workspace` MCP server
+
+## Cursor
+
+- Open the command palette
+- Select "View: Open MCP Settings"
+- Click on "Add custom MCP"
+
+It will open a file with your MCP servers where you can add the following configuration:
+
+```json
+{
+	"mcpServers": {
+		"svelte": {
+			"command": "npx",
+			"args": ["-y", "@sveltejs/mcp"]
+		}
+	}
+}
+```
+
+## Other clients
+
+If we didn't include the MCP client you are using, refer to their documentation for `stdio` servers and use `npx` as the command and `-y @sveltejs/mcp` as the arguments.