Skip to main content
Glama

SFML 3.1.0 Documentation MCP Server (sfml3-ref)

License: MIT SFML Model Context Protocol TypeScript

AI アシスタント(Claude Desktop、Cursor、Claude Code、Cline など)に、完全な SFML 3.1.0 C++ リファレンスドキュメントへの直接かつオフラインでのアクセスを提供する、公式の Model Context Protocol (MCP) サーバーです。


🌟 特徴

  • クリーンな Markdown API リファレンス: Doxygen HTML ドキュメントを解析し、構文ハイライト付きの C++ コードブロックを含む整形された GitHub Markdown に変換します。

  • 完全な C++20 シグネチャ: 指定子([[nodiscard]]、constexpr、explicit、delete、デフォルト引数)を含む完全なメソッドプロトタイプ。

  • モジュール別に分類: 155 以上の全シンボルを、SFML の5つのモジュール(System、Window、Graphics、Audio、Network)にわたって分類。

  • 高速なインメモリ検索: シンボル名、メンバー関数、パラメータ、説明にわたるサブミリ秒の検索。

  • スマートエイリアス: 一般的な SFML の typedef とヘルパーの直接解決(例: Vector2f ➔ sf::Vector2<T>、IntRect ➔ sf::Rect<T>、seconds ➔ sf::Time)。


Related MCP server: Garmin Documentation MCP Server

🛠️ MCP ツール

ツール

パラメータ

説明

list_modules

なし

SFML 3.1.0 の5つの主要モジュールを、説明とシンボル数とともに一覧表示します。

get_module_toc

module_name: string

モジュールの目次(クラス、構造体、列挙型、名前空間、関数)を返します。

search_sfml_symbol

query: string

指定された用語でシンボルとメンバーメソッドを検索します(例: Sprite、setTexture、pollEvent)。

get_sfml_doc

symbol_name: string

特定のシンボルに関する完全な Markdown ドキュメントと C++ プロトタイプを返します(例: sf::Sprite、sf::Vector2、sf::Dns)。


🚀 はじめに

前提条件

  • Node.js(v18.0.0 以上を推奨)

  • npm

インストールとビルド

# 1. Clone the repository
git clone https://github.com/Floxius/sfml3-ref.git
cd sfml3-ref

# 2. Install dependencies
npm install

# 3. Build the TypeScript server
npm run build

注: リポジトリにはビルド済みの index.json(約 1 MB)がすでに含まれているため、インデックススクリプトを再実行したい場合を除き、SFML の Doxygen HTML ファイルをダウンロードする必要はありません。


🖥️ クライアント設定

1. Claude Desktop

Claude Desktop の設定ファイルにサーバーを追加します:

  • Windows: %APPDATA%\Claude\claude_desktop_config.json

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

  • Linux: ~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "sfml3-ref": {
      "command": "node",
      "args": [
        "/ABSOLUTE/PATH/TO/sfml3-ref/dist/src/index.js"
      ]
    }
  }
}

(Windows では、フォワードスラッシュまたは二重バックスラッシュを使用します。例: C:/Users/<username>/Documents/sfml3-ref/dist/src/index.js)

代替方法: tsx で直接実行(ビルド手順不要)

{
  "mcpServers": {
    "sfml3-ref": {
      "command": "npx",
      "args": [
        "-y",
        "tsx",
        "/ABSOLUTE/PATH/TO/sfml3-ref/src/index.ts"
      ]
    }
  }
}

2. Cursor / Cline / その他の MCP クライアント

以下の設定で STDIO MCP サーバーを追加します:

  • コマンド: node

  • 引数: ["/path/to/sfml3-ref/dist/src/index.js"]


📖 使用例

Claude または MCP クライアントに接続すると、次のようなプロンプトを質問できます:

  • "SFML 3.1 で利用可能なすべてのモジュールを一覧表示してください。"

  • "SFML Graphics モジュールのすべてのクラスと関数を表示してください。"

  • "SFML 3 の sf::Sprite のコンストラクタシグネチャは何ですか?"

  • "SFML 3.1 で sf::Dns を使って DNS レコードを照会するにはどうすればよいですか?"

  • "SFML 3 のイベント処理メソッドを検索してください。"


🔄 インデックスの再構築(任意)

index.json を最初から再生成したい場合は:

  1. SFML ウェブサイト から SFML 3.1.0 Doxygen HTML ドキュメントをダウンロードします。

  2. HTML ファイルをリポジトリのルートにある SFML-3.1.0 という名前のフォルダに展開します。

  3. インデックススクリプトを実行します:

    npm run build:index

📄 ライセンス

  • サーバーコード: MIT ライセンス の下でライセンスされています。

  • SFML ドキュメント & ライブラリ: Copyright © Laurent Gomila & SFML Team。SFML は zlib/png ライセンス の規約に基づいてライセンスされています。

Related MCP Connectors

Related MCP Servers