使用说明(Markdown)

  • 项目简介

    • Aspose MCP Server 是一个基于 .NET 8 的 MCP 服务器实现,封装并暴露了对 Aspose.Total 文档组件族的访问能力,旨在为 MCP 客户端提供标准化的上下文服务(Resources、Tools、Prompts),从而使 LLM 可以以统一的方式读取数据、调用外部功能、渲染和使用模板进行对话。
  • 主要功能点

    • 资源管理:托管文档相关的资源与数据,使 LLM 客户端可以读取/访问数据能力。
    • 工具注册与执行:注册并执行对 Word、Excel、PowerPoint、PDF 等办公文档的操作工具,工具集合约90个,覆盖创建、读取、编辑、转换等多种场景。
    • 提示模板(Prompts):支持与 MCP 协议对接的提示模板渲染与使用,方便定义交互模式。
    • JSON-RPC 通信:服务器通过 JSON-RPC 2.0 与客户端进行请求/响应,包含读取资源、调用工具、获取 Prompt 等能力。
    • 会话与安全:包含会话管理、能力声明和安全校验,支持多传输协议(如 STDIO、SSE、WebSocket)以适应不同部署场景。
    • 跨平台打包:基于 .NET 8 自包含发布,生成独立可执行文件,便于在 Windows、Linux、macOS 上部署。
  • 安装步骤

    • 确保系统中已安装 .NET 8.0 运行时(仓库基于 .NET 8 开发)。
    • 获取源码后在本地构建并发布,按照仓库提供的本地构建脚本执行多平台构建(如 Windows、Linux、macOS)。
    • 购买或准备 Aspose 授权文件(Aspose.Total.lic 或分组件授权),并将授授权文件放在可执行文件所在目录,或通过环境变量/命令行参数进行授权配置。
    • 启动服务器(参考下方的配置示例),服务器启动后即可通过 MCP 客户端接入。
  • 服务器配置(MCP 客户端需要的配置信息示例,以下为 JSON 形式,非代码块呈现) 注意:以下示例仅用于说明配置字段,实际路径和参数请结合实际环境填写。 { "serverName": "aspose-mcp-server", "command": "C:/Tools/aspose-mcp-server/AsposeMcpServer.exe", "args": [ "--word", "--excel", "--ppt", "--pdf", "--license:C:/Licenses/Aspose.Total.lic" ], "description": "ASPose MCP Server 实例,提供 Office 文档相关工具与资源服务" }

  • 基本使用方法

    • 启动与接入
      • 启动服务器进程后,MCP 客户端通过占位符的命令和参数(如上述 JSON 示例)启动并连接。
      • 登录/授权:根据授权文件情况,若授权缺失会进入评估模式,生成的文档可能带有评估水印。
    • 常用操作
      • 通过 MCP 客户端请求对文档的操作,例如读取某资源、执行某个工具、渲染指定 Prompts。
      • 服务器端负责会话管理、能力声明,以及对 JSON-RPC 请求的有效处理和错误处理。
    • 安全与合规
      • 服务器实现包含输入输出的安全校验、错误信息清理、以及默认的权限/路径验证策略,生产环境建议提供有效授权且仅暴露必要能力。
  • 备注

    • 项目当前实现包含对 Office 文档类型的综合工具集(Word、Excel、PowerPoint、PDF)的统一接口,对应工具和测试覆盖全面,且具备多平台打包和自包含发布能力。

信息

分类

开发者工具