Go MCP Server Mds

🚀 go-mcp-server-mds

Go言語で実装されたModel Context Protocol (MCP) サーバーで、ファイルシステムからMarkdownファイルを提供します。

🚀 クイックスタート

このサーバーは、Model Context Protocolを通じてMarkdownファイルへのアクセスを提供し、Markdownファイルをリソースとして列挙および読み取ることをサポートしています。YAMLまたはTOMLの前置メタデータ（Frontmatter）付きのMarkdownファイルもサポートしています。

✨ 主な機能

• MCPプロトコルを通じてMarkdownファイルを提供する
• 利用可能なすべてのMarkdownファイルとそのメタデータをリストする
• 単一のMarkdownファイルの内容を読み取る
• YAMLとTOMLの前置メタデータをサポートする
• fs.FS を使用したファイルシステムの抽象化
• URIベースのリソース管理

前置メタデータのサポート

サーバーは、YAMLまたはTOMLの前置メタデータ付きのMarkdownファイルをサポートしています。前置メタデータは、ファイルの先頭にあり、区切り文字で囲まれたメタデータです。

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ドキュメントの整理と記述に役立ちます。

📦 インストール

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

💻 使用例

基本的な使用法

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 文档服务器 です。

利用可能なツール

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 コンポーネントモデル