mcp-svelte-docs

mcp-svelte-docs

site icon
2025.04.18 37
TypeScript文档服务搜索工具开发效率
mcp-svelte-docs 是一个基于 Model Context Protocol (MCP) 的服务器,旨在提供高效访问 Svelte 文档的服务。它具备高级缓存、搜索功能和优化的内容交付能力,支持不同大小的 LLM 上下文窗口。该服务器直接集成 Svelte 官方文档,提供完整和压缩版本的文档内容。
View on GitHub

Overview

基本能力

产品定位

mcp-svelte-docs 是一个专门为 Svelte 开发者设计的文档访问和搜索工具,通过 MCP 协议提供高效的文档服务。

核心功能

  • 完整的 Svelte 文档访问:通过 MCP Resources 提供全面的 Svelte 文档内容。
  • 高级搜索功能:支持文档类型过滤、章节层次感知、智能相关性评分等。
  • 高效缓存:使用 LibSQL 进行高效缓存。
  • 自动内容更新检查:确保文档内容的最新性。
  • 支持包特定文档:包括 Svelte、Kit、CLI 等包的文档。
  • 智能内容分块:适用于大型文档。
  • 压缩版本支持:适用于较小的上下文窗口。

适用场景

  • Svelte 开发者需要快速访问和搜索官方文档。
  • 需要集成 Svelte 文档到开发工具或 IDE 中。
  • 需要高效缓存和快速访问 Svelte 文档的场景。

工具列表

  • search_docs:提供增强的搜索功能,支持高级过滤和上下文感知。
  • get_next_chunk:用于检索大型文档的后续分块。

常见问题解答

  • 如何配置 LibSQL 数据库?通过环境变量 LIBSQL_URLLIBSQL_AUTH_TOKEN 进行配置。
  • 如何访问不同包的文档?通过 URI svelte-docs://docs/{package}/llms.txt 访问特定包的文档。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 安装 pnpm(如果尚未安装):
npm install -g pnpm

安装教程

  1. 克隆仓库:
git clone <repository-url>
  1. 安装依赖:
pnpm install
  1. 构建项目:
pnpm build
  1. 运行开发模式:
pnpm dev

调试方式

  1. 确保服务器已启动并运行。
  2. 使用 MCP 客户端配置进行测试,例如:
{
  "mcpServers": {
    "svelte-docs": {
      "command": "npx",
      "args": ["-y", "mcp-svelte-docs"],
      "env": {
        "LIBSQL_URL": "file:local.db",
        "LIBSQL_AUTH_TOKEN": "your-auth-token-if-using-remote-db"
      }
    }
  }
}
  1. 使用 search_docs 工具进行搜索测试:
{
  "query": "bind:value directive",
  "doc_type": "api",
  "context": 1
}

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。