关于 Ilograph MCP Server
Ilograph MCP Server 是面向 Ilograph 图表工作的非官方社区服务,为 Agent 提供文档、示例、验证和图标搜索工具。
主要功能
- 01获取 Ilograph 文档与规范
- 02验证图表并提供错误指导
- 03浏览带说明的图表示例
- 04按提供方搜索图标
- 05检查服务健康状态与缓存
适用场景
- 01根据自然语言描述起草图表
- 02查找并修复图表语法错误
- 03通过分类示例学习 Ilograph
MCP 相关
它向 MCP 客户端提供 Ilograph 文档、规范、验证、示例、图标搜索和健康检查工具。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
🎯 Ilograph MCP Server
Ilograph MCP 服务是一个 Model Context Protocol (MCP) 服务,可为 AI Agent 提供全面访问 Ilograph 文档、验证工具和图表创建指南的能力。借助智能辅助,转换复杂的架构文档。
使用场景
- 自动创建图表:通过自然语言描述生成 Ilograph 图表
- 实时验证:验证现有图表,并提供详细的错误分析和建议
- 访问文档:即时访问全面的 Ilograph 文档和最佳实践
- 学习与示例:探索精选图表示例及详细说明
重要提示:这是一个非官方的社区项目,与 Ilograph LLC 无关联,也未获其认可。该服务通过访问公开的 Ilograph 文档和资源,提供学习和开发方面的帮助。
注意:MCP 服务提供的输出和建议是动态生成的,可能会因查询和模型不同而有所差异。用户应仔细审查所有输出,确保其符合项目要求,并在实施前对照 Ilograph 官方文档进行核实。
先决条件
- Docker:已安装并运行的 Docker
- 兼容 MCP 的客户端:Claude Desktop、VS Code、Cursor 等
快速开始
添加到 MCP 客户端
将此配置添加到 MCP 客户端:
VS Code:
将以下 JSON 代码块添加到 VS Code 的“用户设置 (JSON)”文件中。你可以按 Ctrl + Shift + P,然后输入“首选项:打开用户设置 (JSON)”来完成此操作。
有关在 VS Code 的 Agent 模式中使用 MCP 服务工具的更多信息,请参阅文档。
{
"mcp": {
"servers": {
"ilograph": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/quincymillerdev/ilograph-mcp-server:latest"
]
}
}
}
}
你也可以选择将类似的示例(即不包含 mcp 键)添加到工作区中的 .vscode/mcp.json 文件。这样便可以与他人共享配置。
{
"servers": {
"ilograph": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/quincymillerdev/ilograph-mcp-server:latest"
]
}
}
}
Claude Desktop / Cursor / Jetbrains AI Assistant:
{
"mcpServers": {
"ilograph": {
"command": "docker",
"args": ["run", "-i", "--rm", "ghcr.io/quincymillerdev/ilograph-mcp-server:latest"]
}
}
}
完成!🎉
工具配置
可用工具
以下工具可全面支持 Ilograph 工作流:
| 类别 | 工具 | 描述 |
|---|---|---|
| 文档 | fetch_documentation_tool | 从 Ilograph 官方来源获取全面的文档,并进行智能缓存 |
| 文档 | list_documentation_sections | 列出所有可用的文档章节及其描述和涵盖范围 |
| 文档 | check_documentation_health | 执行健康检查,并返回文档服务的缓存统计信息 |
| 规范 | fetch_spec_tool | 获取官方 Ilograph 规范,包含完整的属性定义和类型 |
| 规范 | check_spec_health | 专门检查规范服务的连接情况 |
| 示例 | list_examples | 按复杂程度和使用场景分类,列出可用的 Ilograph 示例图 |
| 示例 | fetch_example | 获取特定示例图及其元数据、学习背景和说明 |
| 验证 | validate_diagram_tool | 验证 Ilograph 图的语法,并提供详细的错误消息和建议 |
| 验证 | get_validation_help | 提供有关图表验证和解决常见问题的全面指南 |
| 图标 | search_icons_tool | 通过语义匹配和提供商筛选,搜索 Ilograph 实时图标目录 |
| 图标 | list_icon_providers_tool | 列出所有可用的图标提供商(AWS、Azure、GCP 等)及其服务类别 |
参与贡献
欢迎贡献!本项目需要:
- 🐛 修复错误 - 始终欢迎!
- 📚 改进文档 - 帮助让内容更清晰
- ✨ 新增工具 - 增加更多 Ilograph 功能
- 🔧 提升代码质量 - 改进错误处理等
📖 有关详细的开发环境设置、测试和提交指南,请参阅 CONTRIBUTING.md。
功能
- 📚 实时访问文档:从 Ilograph 官方来源获取最新文档
- 🔍 全面的章节覆盖:访问所有主要的 Ilograph 概念(资源、视角、上下文等)
- ✅ 高级图表验证:验证 YAML 和 Ilograph 架构,并提供详细的错误消息和建议
- ⚡ 智能缓存:基于 TTL 的缓存,并采用回退策略以实现最佳性能
- 🛠️ 工具优先设计:兼容所有当前 MCP 客户端(Cursor、Claude Desktop、VS Code 等)
- 📋 精选示例库:提供真实的 Ilograph 图表及学习背景和说明
- 🎨 智能图标搜索:通过提供商筛选,在 Ilograph 图标目录中进行语义搜索
- 🔄 健康监控:内置服务健康检查和状态报告
- 🏗️ 架构模式检测:识别常见模式并提供优化建议
需要帮助?
- 工具用法:请参阅上方表格中的可用工具
- 问题:GitHub Issues
- 提问:GitHub Discussions
许可证
本项目采用 MIT License 许可,详情请参阅 LICENSE 文件。
法律免责声明
本项目与 Ilograph LLC 无关,未获其认可,也未与其建立联系。 这是一个独立的社区项目,出于教育和开发目的访问公开的 Ilograph 文档和资源。
- Ilograph 名称及相关商标均为 Ilograph LLC 的财产
- 本工具依据合理使用原则访问公开文档
- 用户应参阅 Ilograph 官方文档,以获取权威信息
- 本项目与 Ilograph LLC 之间不存在商业关系
链接
用 ❤️ 为 Ilograph 社区打造
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。