go-mcp-server-mds

go-mcp-server-mds

一个 Go 语言实现的模型上下文协议（MCP）服务，用于从文件系统提供 Markdown 文件。

概述

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

功能

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

Frontmatter 支持

此服务支持带有 YAML 或 TOML frontmatter 的 Markdown 文件。Frontmatter 是放置在 Markdown 文件开头、由分隔符括起来的元数据。

YAML Frontmatter

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

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

# Document Content

TOML Frontmatter

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

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

# Document Content

Frontmatter 元数据会经过解析，并通过服务的工具和资源描述提供。此元数据可以包含任何有效的 YAML 或 TOML 数据，可用于整理和描述 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() {
    // Create a new server using the current directory
    server, err := mcpmds.New(
        "markdown-server",
        "A server that provides access to markdown files",
        os.DirFS("."),
    )
    if err != nil {
        panic(err)
    }

    // Start the server
    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 Documents Server。

可用工具

list_{server-name}_markdown_files

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

• 文件路径
• 文件大小
• 已解析的 frontmatter（如果有）

read_{server-name}_markdown_file

读取指定的 Markdown 文件。需要提供：

• path：Markdown 文件的路径

返回：

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

资源访问

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

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

许可证

本项目采用 MIT 许可证。详情请参阅 LICENSE 文件。

贡献

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