使用说明
- 项目简介
- 本项目实现一个 MCP 服务器,用于对 ALPS 进行验证、转换输出(SVG、Mermaid、DOT/HTML 等)、提供 ALPS 指南,以及通过简易爬取/提取流程生成 ALPS 描述符。
- 服务器通过 MCP 协议向客户端暴露若干工具(如 validate_alps、alps2svg、alps2mermaid、crawl_and_extract_alps、alps_guide、validate_openapi),并返回标准的 JSON-RPC 风格响应。
- 主要功能点
- ALPS 验证:对输入的 ALPS(JSON/XML)进行语法与结构验证,输出错误、警告与建议。
- ALPS 转换输出:将 ALPS 转换为 SVG 图、Mermaid 图、DOT 描述等,支持在服务端生成并返回可用的结果。
- ALPS 指南:提供关于命名约定和三层结构的参考指南,可作为学习材料使用。
- 爬取与提取(部分架构就位,需进一步 AI 集成):为网站生成 ALPS 描述符的工作流骨架,当前实现提供接口与占位信息,未来可通过 AI 增强分析。
- 兼容性与扩展:代码结构清晰,便于后续扩展更多 ALPS 场景与输出格式。
- 安装与运行
- 克隆仓库后进入/mcp 目录,安装依赖并编译运行 MCP 服务器(实际操作通常包含安装 Node/TypeScript 构建工具、运行 build、启动服务器等步骤)。
- 运行后,客户端通过 MCP 协议向服务器发起 ListTools 请求获取工具列表,随后通过 CallTool 请求调用相应工具。
- MCP 客户端配置(示例,非代码)
- 服务器名称与启动命令(用于客户端连接服务器)
- 以 JSON 格式提供如下信息(请替换为实际部署路径与命令): { "serverName": "alps-tools-mcp-server", "command": "node", "args": ["dist/index.js"], "transport": "stdio" } 说明:
- serverName: MCP 客户端用于标识目标服务器的名称。
- command: 启动服务器所用的命令(如 node)。
- args: 启动命令的参数列表,此处假设打包后入口在 dist/index.js。
- transport: 指明通信传输方式,此处采用 stdio(通常为 MCP 客户端/服务端通过标准输入输出进行 RPC 通信)。
- 基本使用方法
- 启动服务器:将上述配置在客户端 MCP 设置中保存后,客户端通过指定的命令启动服务器进程,建立 JSON-RPC 连接。
- 使用工具:
- 调用 validate_alps:提交 alps_content(JSON 或 XML 字符串),获取验证结果与错误信息。
- 调用 alps2svg / alps2mermaid / alps2svg:提交 ALPS 内容,获取相应的 SVG/Mermaid/图形输出。
- 调用 alps_guide:获取帮助文档和最佳实践文本。
- 调用 crawl_and_extract_alps:触发站点爬取与 ALPS 生成流程(当前实现为框架性实现,依赖 AI 调用完成完整输出)。
- 结果处理:MCP 客户端接收 JSON-RPC 响应,解析 content 字段中的文本/代码块以展示给最终 LLM 客户端或 UI。
信息
分类
AI与计算