Go MCP Server Mds

🚀 go-mcp-server-mds

go-mcp-server-mds 是一个使用 Go 语言实现的 Model Context Protocol (MCP) 服务器，它的主要作用是从文件系统中提供 Markdown 文件服务，让用户可以方便地访问和管理 Markdown 文件。

🚀 快速开始

go-mcp-server-mds 是一个强大的工具，能通过 MCP 协议提供 Markdown 文件服务。下面为你介绍如何快速开启使用之旅。

安装

使用以下命令进行安装：

go get github.com/Warashi/go-mcp-server-mds

使用示例

以下是创建和使用 MCP Markdown 服务器的基本示例：

package main

import (
    "context"
    "os"

    mcpmds "github.com/Warashi/go-mcp-server-mds"
)

func main() {
    // 创建一个新的服务器实例，使用当前目录
    server, err := mcpmds.New(
        "markdown-server",
        "提供对 Markdown 文件访问的服务器",
        os.DirFS("."),
    )
    if err != nil {
        panic(err)
    }

    // 启动服务器
    if err := server.ServeStdio(context.Background()); err != nil {
        panic(err)
    }
}

命令行工具（mcp-server-mds）

此仓库包含一个命令行工具 mcp-server-mds，可以直接运行服务器。

安装命令行工具

要构建命令行工具，使用以下命令：

go install github.com/Warashi/go-mcp-server-mds/cmd/mcp-server-mds@latest

运行服务器

要运行服务器，请执行已构建的二进制文件。它会从指定目录提供 Markdown 文件的服务。

$HOME/go/bin/mcp-server-mds -path /path/to/your/markdown/files

参数说明：

• -path：指定包含要提供的 Markdown 文件的目录，默认为当前目录（.）。
• -name：设置服务器名称，默认为 mcp-server-mds。
• -description：设置服务器描述，默认为 Markdown 文档服务器。

✨ 主要特性

• MCP 协议服务：通过 MCP 协议提供 Markdown 文件服务，方便快捷。
• 文件列举：可以列出所有可用的 Markdown 文件及其元数据，便于管理。
• 文件读取：支持读取单个 Markdown 文件内容。
• 前置元数据支持：支持 YAML 和 TOML 前置元数据，增强文档的组织性。
• 文件系统抽象：使用 fs.FS 实现文件系统抽象，提高灵活性。
• 资源管理：基于 URI 的资源管理，方便资源的访问和定位。

📦 安装指南

安装服务器

go get github.com/Warashi/go-mcp-server-mds

安装命令行工具

go install github.com/Warashi/go-mcp-server-mds/cmd/mcp-server-mds@latest

💻 使用示例

基础用法

以下是创建和使用 MCP Markdown 服务器的基本示例：

package main

import (
    "context"
    "os"

    mcpmds "github.com/Warashi/go-mcp-server-mds"
)

func main() {
    // 创建一个新的服务器实例，使用当前目录
    server, err := mcpmds.New(
        "markdown-server",
        "提供对 Markdown 文件访问的服务器",
        os.DirFS("."),
    )
    if err != nil {
        panic(err)
    }

    // 启动服务器
    if err := server.ServeStdio(context.Background()); err != nil {
        panic(err)
    }
}

📚 详细文档

前置元数据支持

服务器支持带有 YAML 或 TOML 前置元数据的 Markdown 文件。前置元数据是指放在文件开头、由分隔符包围的 metadata。

YAML 前置元数据

YAML 使用 --- 作为分隔符：

---
title: My Document
date: 2024-03-21
tags: [documentation, markdown]
---

# 文档内容

TOML 前置元数据

TOML 使用 +++ 作为分隔符：

+++
title = "My Document"
date = 2024-03-21
tags = ["documentation", "markdown"]
+++

# 文档内容

前置元数据会被解析并可通过服务器工具和资源描述获取。此元数据可以包含任何有效的 YAML 或 TOML 数据，适用于组织和描述 Markdown 文档。

可用工具

list_{server-name}_markdown_files

列出服务器管理的所有 Markdown 文件。返回的信息包括：

• 文件路径
• 文件大小
• 解析后的前置元数据（如果存在）

read_{server-name}_markdown_file

读取特定的 Markdown 文件。需要以下参数：

• path：Markdown 文件的路径 返回的信息包括：
• 文件路径
• 文件大小
• 解析后的前置元数据
• 完整文件内容

资源访问

资源可通过 file:// URI 访问。每个 Markdown 文件都会注册为一个资源，属性如下：

• URI：file://{path}
• 名称：基础文件名
• 描述：JSON 编码的前置元数据
• MIME 类型：text/markdown
• 大小：文件大小（字节）

📄 许可证

此项目使用 MIT 许可证。有关详细信息，请参阅 LICENSE。

🤝 贡献指南

欢迎贡献！请参考 CONTRIBUTING.md 了解如何参与开发。

📚 参考文档

• Model Context Protocol (MCP)
• Go 官方文档
• W3C WebAssembly 组件模型