清晰-mcp-服务器
项目介绍
Lucid MCP Server
用于 Lucid 应用集成的 Model Context Protocol (MCP) 服务器。使多模态大语言模型能够通过视觉导出访问和分析 Lucid 图表。
目录
特性
- 🔍 文档发现 和从 LucidChart、LucidSpark 和 LucidScale 获取元数据
- 📑 轻量级标签元数据 快速查看文档结构
- 🖼️ 从 Lucid 图表导出 PNG 图像
- 🤖 AI 动力图表分析 使用多模态大语言模型（支持 Azure OpenAI 和 OpenAI）
- ⚙️ 基于环境的 API 密钥管理 自动从 Azure 切换到 OpenAI。
- 📝 TypeScript 实现 具有完整的测试覆盖率
- 🔧 MCP Inspector 集成 方便测试
先决条件
在开始之前，请确保您拥有以下内容：
- Node.js: 版本 18 或更高。
- Lucid API 密钥: 从 Lucid 开发者门户 获取的密钥是 必需的。
- AI 提供商密钥（可选）: 对于 AI 动力图表分析，您需要一个 API 密钥，可以是：
快速开始
按照这些步骤来运行服务器。
通过 Smithery 安装
要通过 Smithery 自动安装 lucid-mcp-server 到 Claude Desktop：
npx -y @smithery/cli install @smartzan63/lucid-mcp-server --client claude
1. 安装
全局安装 npm 包：
npm install -g lucid-mcp-server
2. 配置
在终端中设置以下环境变量。只需 Lucid API 密钥即可。
# 所有功能都需要
export LUCID_API_KEY="your_api_key_here"
# 可选：对于 AI 分析，配置 Azure OpenAI 或 OpenAI
# 选项 1：Azure OpenAI（优先）
export AZURE_OPENAI_API_KEY="your_azure_openai_key"
export AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com"
export AZURE_OPENAI_DEPLOYMENT_NAME="gpt-4o"
# 选项 2：OpenAI（如果未配置 Azure，则作为备用）
export OPENAI_API_KEY="your_openai_api_key"
export OPENAI_MODEL="gpt-4o" # 可选，默认为 gpt-4o
注意：如果设置了
AZURE_OPENAI_API_KEY，服务器会自动使用 Azure OpenAI。如果没有设置，且提供了OPENAI_API_KEY，则会使用 OpenAI。
3. 验证
使用 MCP Inspector 测试您的安装：
npx @modelcontextprotocol/inspector lucid-mcp-server
使用方法
一旦服务器运行，您可以使用自然语言或直接调用其工具进行交互。
示例提示
-
基本命令（仅需 Lucid API 密钥）：
- "显示我所有的 Lucid 文档"
- "获取文档信息，ID 为：[document-id]"
-
AI 分析（需要 Azure OpenAI 或 OpenAI 设置）：
- "分析这个图表：[document-id]"
- "这个 Lucid 图表展示了什么：[document-id]"
可用工具
🔍 search-documents
列出您 Lucid 账户中的文档。
- 参数：
keywords(字符串，可选)：搜索关键词以过滤文档。
- 示例：
{ "keywords": "架构图" }
📋 get-document
获取文档元数据，并可选择对视觉内容进行 AI 分析。
- 参数：
documentId(字符串)：来自 Lucid URL 的文档 ID。analyzeImage(布尔值，可选)：设为true以执行 AI 分析。⚠️ 需要 Azure 或 OpenAI 密钥。pageId(字符串，可选)：要导出的具体页面（默认："0_0")。
- 示例：
{ "documentId": "demo-document-id-here-12345678/edit", "analyzeImage": true }
📑 get-document-tabs
获取关于所有标签（页面）的轻量级元数据，无需检索完整内容。
- 参数：
documentId(字符串)：来自 Lucid URL 的文档 ID。
- 返回：文档信息，带有页面元数据（id、title、index），便于快速导航和概览。
- 示例：
{ "documentId": "demo-document-id-here-12345678/edit" }
VS Code 集成
您可以直接将服务器集成到 Visual Studio Code 中。
方法 1：通过 VS Code UI（推荐）
- 打开 命令面板 (
Ctrl+Shift+P或Cmd+Shift+P)。 - 运行命令："MCP: 添加服务器"。
- 选择 "npm" 作为来源。
- 输入包名：
lucid-mcp-server。 - VS Code 将引导您完成其余设置。
- 验证自动创建的配置，因为 AI 可能会犯错。
方法 2：快速安装链接
点击此 README 顶部的 "在 VS Code 中安装" 徽章，然后按照屏幕上的提示操作。您需要手动在 settings.json 中配置环境变量。
方法 3：手动配置
<details> <summary>点击以查看手动 `settings.json` 配置</summary>将以下 JSON 添加到您的 VS Code settings.json 文件中。此方法提供最大的控制权，适用于自定义设置。
{
"mcp": {
"servers": {
"lucid-mcp-server": {
"type": "stdio",
"command": "lucid-mcp-server",
"env": {
"LUCID_API_KEY": "${input:lucid_api_key}",
"AZURE_OPENAI_API_KEY": "${input:azure_openai_api_key}",
"AZURE_OPENAI_ENDPOINT": "${input:azure_openai_endpoint}",
"AZURE_OPENAI_DEPLOYMENT_NAME": "${input:azure_openai_deployment_name}",
"OPENAI_API_KEY": "${input:openai_api_key}",
"OPENAI_MODEL": "${input:openai_model}"
}
}
},
"inputs": [
{
"id": "lucid_api_key",
"type": "promptString",
"description": "Lucid API 密钥（必需）"
},
{
"id": "azure_openai_api_key",
1. "type": "promptString",
1. "description": "Azure OpenAI API 密钥（可选，用于 AI 分析）"
1. },
1. {
1. "id": "azure_openai_endpoint",
1. "type": "promptString",
1. "description": "Azure OpenAI 终端（可选，用于 AI 分析）"
1. },
1. {
1. "id": "azure_openai_deployment_name",
1. "type": "promptString",
1. "description": "Azure OpenAI 部署名称（可选，用于 AI 分析）"
1. },
1. {
1. "id": "openai_api_key",
1. "type": "promptString",
1. "description": "OpenAI API 密钥（可选，用于 AI 分析 - 如果未配置 Azure）"
1. },
1. {
1. "id": "openai_model",
1. "type": "promptString",
1. "description": "OpenAI 模型（可选，用于 AI 分析，默认为 gpt-4o）"
1. }
1. ]
1. }
1. }
1. }
小演示
🤝 贡献
- 分叉仓库。
- 创建您的功能分支 (
git checkout -b feature/amazing-feature)。 - 提交更改 (
git commit -m '添加神奇功能')。 - 推送到分支 (
git push origin feature/amazing-feature)。 - 打开拉取请求。
📚 参考资料
📄 许可证
本项目采用 MIT 许可证 - 查看 LICENSE 文件以获取详细信息。