MarkView MCP 服务端

使用说明(Markdown 格式)

  • 项目简介

    • MarkView MCP 服务端是为 AI 助手提供 Markdown 预览能力的服务器端实现。核心通过 MCP JSON-RPC 规范,与客户端进行资源访问、工具执行和提示模板相关的请求和响应。
  • 主要功能点

    • 基本协议实现:实现 MCP 的核心请求/响应处理,提供与 LLM 客户端的标准化通信。
    • 工具注册与执行:暴露工具集,如预览 Markdown、打开文件等,LLM 客户端可通过调用工具实现外部功能。
    • 资源与数据能力:通过服务端对本地 Markdown 文件、插件资源等进行访问与管理,便于在对话中动态获取上下文信息。
    • Prompt(模板)定义与渲染:支持以模板化形式渲染与返回交互所需的提示信息。
    • 传输与会话:服务器端负责会话管理、能力声明,并通过多种传输方式(如 STDIO)对外暴露。
  • 安装步骤

    • 该仓库包含一个 MCP 服务器实现以及一个后处理安装脚本,安装过程核心包括:从 MarkView 的发行包中获取 MCP 服务器二进制,并确保放置在可执行路径中以供命令包装器调用。
    • 若直接使用本仓库提供的二进制,需确保 macOS 运行环境并信任所下载的应用程序包。
  • 服务器配置(MCP 客户端所需)

    • MCP 客户端在首次接入时需配置服务器信息以建立连接。以下配置示例用于 Claude 或其他 MCP 客户端的注册,请以文本形式填写或粘贴到配置文件中:
    • 配置示例(JSON,包含服务器名称、启动命令及参数): { "mcpServers": { "markview": { "command": "npx", "args": ["mcp-server-markview"] } // 说明:以上配置表示服务器名称为 markview,启动命令为 npx,参数为 mcp-server-markview } // 注:MCP 客户端本身不需要额外的服务端注释信息,此处仅为使用方提供启动配置示例 }
    • 备注:客户端仅需提供启动命令(command)及参数(args),以便启动并与 MCP 服务器建立通信。
  • 基本使用方法

    • 启动服务器
      • 使用 MCP 客户端的集成方式,按配置启动 markview 服务器实例。
    • 调用工具
      • 通过 MCP 客户端调用工具(如 preview_markdown、open_file),将 MarkView 的相关功能接入到对话中。
    • 资源访问
      • 通过 MCP 请求访问本地 Markdown 文件、以及 MarkView 的插件资源,以获得上下文信息用于对话生成。
    • Prompts 与渲染
      • 以模板形式获取并渲染提示文本,确保 LLM 在交互中获得一致的上下文信息。
  • 基本注意事项

    • 该 MCP 服务端旨在对接 MCP 客户端,确保客户端具备相应的启动命令与参数即可接入使用。
    • 运行环境建议 macOS,以及与开发说明中一致的 Swift/Xcode 版本要求(如仓库文档所述)。

服务器信息