使用说明

项目简介

该项目名为 Whimsical MCP Server，是一个基于 Model Context Protocol (MCP) 构建的服务器应用。它作为一个桥梁，连接 LLM 客户端和 Whimsical 在线图表工具。通过此 MCP 服务器，LLM 可以调用预设的工具，利用 Mermaid 标记语言自动生成精美的 Whimsical 图表，并获取图表链接和图片数据，从而增强 LLM 在可视化方面的能力。

主要功能点

Mermaid 图表生成: 接收 LLM 客户端提供的 Mermaid 标记文本，调用 Whimsical API 生成相应的图表。
多格式图表输出: 返回 Whimsical 图表的 URL 链接，方便在线访问；同时提供 Base64 编码的图片数据，便于在客户端直接展示和迭代。
资源链接: 返回包含 Whimsical 图表 URL 的资源链接 (Resource)，符合 MCP 协议规范，方便客户端管理和引用。
标准 MCP 服务器: 基于 '@modelcontextprotocol/sdk' 开发，遵循 MCP 协议，易于与任何兼容 MCP 协议的 LLM 客户端集成。

安装步骤

克隆仓库

git clone https://github.com/BrockReece/whimsical-mcp-server.git
cd whimsical-mcp-server

安装依赖 确保已安装 Node.js 和 yarn (或 npm)。
```
yarn install
```
构建项目
```
yarn build
```
构建成功后，会在 'dist' 目录下生成服务器代码 'index.js'。

服务器配置

对于需要对接此 MCP 服务器的 LLM 客户端，需要在客户端的 MCP 服务器配置中添加以下信息。以下是一个 JSON 格式的配置示例，用于说明如何配置 Whimsical MCP Server。请注意，以下配置信息是提供给 MCP 客户端使用的，不是直接在服务器端配置的。 客户端会根据这些配置信息启动并连接到 MCP 服务器。

{
    "mcpServers": {
        "whimsical": {  //  服务器名称，客户端用于在请求中指定使用的服务器
            "command": "node",  //  启动服务器的命令，这里使用 node.js 运行时
            "args": [          //  启动命令的参数，指向构建后的服务器入口文件
                "/path/to/whimsical-mcp-server/dist/index.js"  //  请替换为实际的 whimsical-mcp-server 仓库 dist 目录下的 index.js 文件的绝对路径
            ]
        }
    }
}

配置说明:

'"mcpServers"': MCP 客户端配置中用于定义 MCP 服务器的部分。
'"whimsical"': 为该 Whimsical MCP Server 定义的服务器名称，可以自定义，客户端在调用工具时会使用此名称。
'"command": "node"': 指定运行服务器端代码的命令为 'node'，假设您的运行环境中可以通过 'node' 命令执行 JavaScript 代码。
'"args": [...]"': 命令参数数组，这里只有一个参数，即服务器入口文件 'index.js' 的路径。请务必将 '/path/to/whimsical-mcp-server/dist/index.js' 替换为您本地 whimsical-mcp-server 仓库 'dist/index.js' 文件的实际绝对路径。

基本使用方法

启动 MCP 服务器: 按照上述 "服务器配置" 中的说明，在 MCP 客户端中配置好 Whimsical MCP Server，并启动客户端。客户端会自动根据配置启动并连接到 Whimsical MCP Server。
调用 'create_whimsical_diagram' 工具: 在 LLM 客户端中，可以使用 'create_whimsical_diagram' 这个工具来生成 Whimsical 图表。该工具接受两个参数：
- 'mermaid_markup': 图表的 Mermaid 标记文本 (字符串类型)。
- 'title': 图表的标题 (字符串类型)。
例如，客户端可以构造一个工具调用请求，指定使用 'whimsical' 服务器 (配置中定义的服务器名称)，并传入 Mermaid 标记和标题，服务器会处理请求，调用 Whimsical API 生成图表，并将图表 URL、Base64 图片数据以及资源链接返回给客户端。

客户端接收到响应后，可以解析响应内容，获取图表 URL 进行在线查看，或者直接在客户端展示 Base64 编码的图片。

注意: 此 MCP 服务器依赖于 Whimsical 提供的 API 接口。请确保 Whimsical API 的可用性和稳定性。

关键词