Ilograph MCP 服务器

Ilograph MCP 服务器是一个为AI代理提供全面访问Ilograph文档、验证工具和图表创建指导的服务器,通过智能辅助简化复杂架构文档的处理。

  • by QuincyMillerDev
  • Python
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 QuincyMillerDev/ilograph-mcp-server

使用说明

🎯 Ilograph MCP服务器

Ilograph MCP服务器是 模型上下文协议(MCP) 服务器,为AI代理提供对Ilograph文档、验证工具和图表创建指导的全面访问。在智能辅助下转换复杂的架构文档。

用例

  • 自动图表创建:通过自然语言描述生成Ilograph图
  • 实时验证:通过详细的错误分析和建议验证现有图表
  • 文档访问:立即访问全面的Ilograph文档和最佳实践
  • 学习与示例:探索精心策划的图表示例,并附上详细解释

重要:这是一个 非官方、社区驱动的项目 并且是 不隶属于Ilograph LLC或得到其认可该服务器通过访问公开的Ilograph文档和资源提供教育和发展援助。

小心MCP服务器提供的输出和建议是动态生成的,可能因查询和模型而异。用户应该 彻底审查所有输出 确保他们符合项目要求 根据官方Ilograph文件进行验证 在实施之前。

先决条件

  1. 码头工人: 码头工人 已安装并正在运行
  2. MCP兼容客户端:克劳德桌面、VS代码、光标等。

快速开始

添加到您的MCP客户端

将此配置添加到MCP客户端:

VS代码:

将以下JSON块添加到VS Code中的用户设置(JSON)文件中。您可以通过按Ctrl+Shift+P并键入首选项:打开用户设置(JSON)来完成此操作。

关于在VS Code的代理模式文档中使用MCP服务器工具的更多信息。

{
  "mcp": {
    "servers": {
      "ilograph": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "ghcr.io/quincymillerdev/ilograph-mcp-server:latest"
        ]
      }
    }
  }
}

您可以选择在工作区中的.vcode/mcp.json文件中添加一个类似的示例(即没有mcp键)。这将允许您与他人共享配置。

{
  "servers": {
    "ilograph": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/quincymillerdev/ilograph-mcp-server:latest"
      ]
    }
  }
}

克劳德桌面/光标/Jetbrains人工智能助手:

{
  "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功能
  • 🔧 代码质量 -更好的错误处理等。

📖 看 贡献.md 了解详细的开发设置、测试和提交指南。

特性

  • 📚 实时文档访问:从官方Ilograph来源获取最新文档
  • 🔍 综合路段覆盖:访问所有主要的Ilograph概念(资源、观点、背景等)
  • ✅ 高级图表验证:YAML和Ilograph模式验证,包括详细的错误消息和建议
  • ⚡ 智能高速缓存:基于TTL的缓存,具有回退策略,可实现最佳性能
  • 🛠️ 工具优先设计:兼容所有当前的MCP客户端(Cursor、Claude Desktop、VS Code等)
  • 📋 精选示例库:带有学习背景和解释的真实世界图表
  • 🎨 智能图标搜索:通过Ilograph的图标目录进行语义搜索,并进行提供者过滤
  • 🔄 健康监测:内置服务健康检查和状态报告
  • 🏗️ 架构模式检测:确定常见模式并提供优化建议

需要帮助?

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

法律免责声明

本项目与Ilograph LLC没有附属关系、背书或联系。 这是一个独立的、社区驱动的工具,可以访问公开可用的Ilograph文档和资源,用于教育和发展目的。

  • Ilograph名称和相关商标是Ilograph LLC的财产
  • 该工具根据合理使用原则访问公开可用的文档
  • 用户应参考官方Ilograph文档以获取权威信息
  • 本项目与Ilograph LLC之间不存在商业关系

链接


内置于❤️ 为Ilograph社区