Go MCP Server Mds

🚀 go-mcp-server-mds

go-mcp-server-mds 是一個用 Go 語言實現的 Model Context Protocol (MCP) 服務器，它能從文件系統中提供 Markdown 文件服務，為 Markdown 文件的管理和訪問提供了便捷的解決方案。

🚀 快速開始

go-mcp-server-mds 是一個強大的工具，可幫助你輕鬆管理和訪問 Markdown 文件。以下是快速使用該服務器的步驟：

1. 安裝：

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

2. 使用示例：

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 協議支持：通過 MCP 協議提供 Markdown 文件服務，方便用戶訪問和管理 Markdown 文件。
• 文件列舉與讀取：支持列出所有可用的 Markdown 文件及其元數據，也能讀取單個 Markdown 文件的內容。
• 前置元數據解析：支持 YAML 和 TOML 前置元數據，可對其進行解析並通過服務器工具和資源描述獲取。
• 文件系統抽象：使用 fs.FS 實現文件系統抽象，提高代碼的可移植性和可維護性。
• URI 資源管理：基於 URI 進行資源管理，每個 Markdown 文件都可通過 file:// URI 進行訪問。

📦 安裝指南

安裝服務器

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

安裝命令行工具

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

💻 使用示例

基礎用法

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)
    }
}

高級用法

使用命令行工具啟動服務器：

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

參數說明：

• -path：指定包含要提供的 Markdown 文件的目錄，默認為當前目錄（.）。
• -name：設置服務器名稱，默認為 mcp-server-mds。
• -description：設置服務器描述，默認為 Markdown 文檔服務器。

📚 詳細文檔

可用工具

list_{server-name}_markdown_files

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

• 文件路徑
• 文件大小
• 解析後的前置元數據（如果存在）

read_{server-name}_markdown_file

讀取特定的 Markdown 文件。需要以下參數：

• path：Markdown 文件的路徑

返回的信息包括：

• 文件路徑
• 文件大小
• 解析後的前置元數據
• 完整文件內容

資源訪問

資源可通過 file:// URI 訪問。每個 Markdown 文件都會註冊為一個資源，屬性如下：

🔧 技術細節

前置元數據支持

服務器支持帶有 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 文檔。

📄 許可證

此項目使用 MIT 許可證。有關詳細信息，請參閱 LICENSE。

貢獻指南

歡迎貢獻！請參考 CONTRIBUTING.md 瞭解如何參與開發。

參考文檔

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