go-mcp-server-mds

一个使用 Go 语言实现的模型上下文协议 (MCP) 服务器，用于从文件系统提供 markdown 文件。

概述

此服务器提供了一种通过模型上下文协议暴露 markdown 文件的方式，使其可以作为资源访问，并提供列出和读取 markdown 文件的工具。它支持带有 YAML 或 TOML frontmatter 的 markdown 文件。

特性

• 通过 MCP 提供 markdown 文件
• 列出所有可用的 markdown 文件及其元数据
• 读取单个 markdown 文件的内容
• 支持 YAML 和 TOML frontmatter
• 使用 fs.FS 进行文件系统抽象
• 使用基于 URI 的访问进行资源管理

安装

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

用法

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

package main

import (
    "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 文件的目录。默认为当前目录 (.)。

可用工具

listMarkdownFiles

列出服务器管理的所有 markdown 文件。返回的元数据包括：

• 文件路径
• 文件大小
• 解析后的 frontmatter（如果可用）

readMarkdownFile

读取特定的 markdown 文件。需要：

• path: markdown 文件的路径

返回：

• 文件路径
• 文件大小
• 解析后的 frontmatter
• 完整的文件内容

资源访问

资源可以通过 file:// URI 访问。每个 markdown 文件都注册为一个资源，具有以下属性：

• URI: file://{path}
• 名称: 基本文件名
• 描述: JSON 编码的 frontmatter
• MimeType: text/markdown
• 大小: 文件大小（字节）

许可证

此项目根据 MIT 许可证获得许可。有关详细信息，请参阅 LICENSE 文件。

贡献

欢迎贡献！请随时提交 Pull Request。