mcp-svelte-docs

mcp-svelte-docs

一个 Model Context Protocol（MCP）服务，直接从 TypeScript 声明中提取权威的 Svelte 5 和 SvelteKit 定义。通过统一接口，获取所有 Svelte 5 概念的精确语法、参数和示例。

架构

定义优先的方法：此服务不提供多个专用工具，而是提供一个强大的 svelte_definition 工具， 可访问 28+ 个全面的定义，涵盖：

• 所有 Svelte 5 runes（$state、$derived、$props、$effect 变体）
• 现代功能（snippets、await 表达式、远程函数）
• 事件处理（DOM 事件、自定义事件、组件通信）
• 迁移指南（Svelte 4 到 5 的模式和最佳实践）
• TypeScript 接口（Snippet、Snapshot 类型）
• 高级模式（全局状态、常见错误、生命周期等效项）

可用工具

svelte_definition

强大的单一工具，适用于所有 Svelte 5 和 SvelteKit 概念：

svelte_definition(identifier: string, format?: "syntax"|"quick"|"full")

示例：

• svelte_definition("$state") - 完整的 $state 文档
• svelte_definition("snippets", "quick") - Snippet 概览及示例
• svelte_definition("onclick", "syntax") - 仅 TypeScript 签名
• svelte_definition("migration-patterns") - Svelte 4 → 5 迁移指南

响应格式：

• "syntax" - 仅 TypeScript 签名（约 50 个词）
• "quick" - 定义 + 简要示例（约 200 个词）
• "full" - 完整文档及示例（约 500–1000 个词，默认）

可用标识符（28+）

核心 Runes： $state、$state.raw、$state.snapshot、$derived、 $derived.by、$props、$bindable、$effect、$effect.pre、 $effect.root、$effect.pending、$effect.tracking

开发工具： $inspect、$host

功能与模式： snippets、onclick、component-events、 migration-patterns、await-expressions、remote-functions、 global-state、common-mistakes、lifecycle-equivalents

事件处理： custom-events、event-delegation、 event-modifiers

TypeScript 接口： snippet、snapshot

主要功能

🎯 权威且以 TypeScript 为先

• 直接来自源码：定义提取自 Svelte 5 官方 TypeScript 声明
• 始终保持最新：反映实际 API，而非过时教程
• 类型安全：包含精确的参数类型、返回值和 限制条件

⚡ 单一接口，全面覆盖

• 一个工具：svelte_definition 可替代 16+ 个专用工具
• 28+ 个定义：涵盖每个 Svelte 5 rune、功能和 模式
• 一致的响应：无论查询 $state 还是 remote-functions， 都使用相同接口

🚀 支持现代 Svelte 5 和 SvelteKit

• Await 表达式：在模板中直接执行异步操作 （await-expressions）
• 远程函数：类型安全的客户端-服务端通信 （remote-functions）
• 所有 Runes：完整的 $effect 系列、$state 变体、 $derived.by、$bindable
• 高级模式：事件处理、全局状态、组件通信

📚 智能错误恢复

• 模糊匹配：针对拼写错误建议正确的标识符
• 相关概念：搜索失败时提供相似定义
• 迁移帮助：将 Svelte 4 模式转换为 Svelte 5 等效项

配置

Claude Desktop（通过 WSL）

{
	"mcpServers": {
		"mcp-svelte-docs": {
			"command": "wsl.exe",
			"args": ["bash", "-c", "npx -y mcp-svelte-docs"]
		}
	}
}

Cursor

Windsurf（通过 WSL）

{
	"mcpServers": {
		"mcp-svelte-docs": {
			"command": "wsl.exe",
			"args": ["bash", "-c", "npx -y mcp-svelte-docs"]
		}
	}
}

Windows（不使用 WSL）

{
	"mcpServers": {
		"mcp-svelte-docs": {
			"command": "npx",
			"args": ["-y", "mcp-svelte-docs"]
		}
	}
}

macOS / Linux

{
	"mcpServers": {
		"mcp-svelte-docs": {
			"command": "npx",
			"args": ["-y", "mcp-svelte-docs"]
		}
	}
}

贡献

欢迎贡献！请随时提交 Pull Request。

许可证

MIT 许可证 - 详情请参阅 LICENSE 文件。

致谢

基于：

• Model Context Protocol
• Svelte