使用说明

项目简介

Flutter Notes Server 是一个基于 TypeScript 开发的 MCP 服务器，它并非用于管理笔记，而是作为一个示例，演示如何使用 MCP 协议为 LLM 客户端提供访问 Flutter 文档搜索功能。该服务器允许 LLM 通过 'search_flutter_docs' 工具查询 Flutter 官方文档，从而获取最新的 Flutter 开发信息。

主要功能点

文档搜索工具: 提供 'search_flutter_docs' 工具，LLM 客户端可以调用此工具并传入关键词，服务器将返回 Flutter 官方文档的搜索结果。
基于 MCP 协议: 完全遵循 Model Context Protocol 协议，可以与任何兼容 MCP 协议的 LLM 客户端进行交互。
Stdio 传输: 使用标准的 Stdio (标准输入输出) 作为 MCP 通信协议，易于集成和部署。

安装步骤

安装 Node.js 和 npm: 确保你的电脑上已经安装了 Node.js 和 npm (Node 包管理器)。你可以从 nodejs.org 下载并安装。
下载仓库代码: 从 GitHub 仓库 https://github.com/robert-northmind/flutter-mcp 下载代码到本地。你可以使用 'git clone https://github.com/robert-northmind/flutter-mcp' 命令克隆仓库，或者直接下载 ZIP 文件并解压。
安装依赖: 打开终端或命令提示符，进入仓库代码所在的目录，运行以下命令安装项目依赖：
```
npm install
```
构建项目: 运行以下命令构建项目，将 TypeScript 代码编译成 JavaScript 代码：
```
npm run build
```
构建成功后，会在 'build' 目录下生成 'index.js' 文件，这就是服务器的入口文件。

服务器配置

MCP 服务器需要配置到兼容 MCP 协议的 LLM 客户端中才能使用。以 Claude Desktop 为例，你需要修改 Claude 的配置文件 'claude_desktop_config.json'。

配置文件路径：

MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置内容：

在 'claude_desktop_config.json' 文件中，找到 'mcpServers' 字段（如果没有则手动添加），添加以下配置信息。请将 '/path/to/flutter/build/index.js' 替换为 你本地 flutter-mcp 项目 'build/index.js' 文件的实际路径。

{
  "mcpServers": {
    "flutter-docs": {  // 服务器名称，可以自定义，例如 "flutter-docs"
      "command": "/path/to/flutter/build/index.js" //  flutter-mcp 服务器的启动命令，指向 build 后的 index.js 文件
    }
  }
}

注意:

确保 'command' 字段指向的路径是正确的 'index.js' 文件路径。
服务器名称 ('flutter-docs') 可以自定义，在 LLM 客户端中引用时需要使用此名称。
无需配置 'args' 参数，因为此服务器不需要额外的启动参数。

基本使用方法

配置完成后，启动你的 LLM 客户端 (例如 Claude Desktop)。客户端应该能够检测到你配置的 MCP 服务器。

使用 'search_flutter_docs' 工具：

在 LLM 客户端中，你可以指示 LLM 使用 'search_flutter_docs' 工具来搜索 Flutter 文档。例如，你可以向 LLM 提问：

'使用 flutter-docs 服务器的 search_flutter_docs 工具，搜索关于 "StatelessWidget" 的文档。'

LLM 客户端会解析你的指令，并根据 MCP 协议调用 'flutter-docs' 服务器的 'search_flutter_docs' 工具，将 "StatelessWidget" 作为 'query' 参数发送给服务器。服务器会查询 Flutter 文档，并将搜索结果返回给 LLM 客户端，最终由 LLM 呈现给你。

调试 (可选):

如果需要调试 MCP 服务器，可以使用 MCP Inspector。按照 'README.md' 中的说明运行 'npm run inspector' 启动 Inspector，并通过浏览器访问提供的 URL 进行调试。

关键词