MCP Osrs

🚀 OSRS MCP Server

このOSRS MCP Serverは、Old School RuneScape (OSRS) ウィキAPIおよびデータファイルとやり取りするためのサーバーです。Model Context Protocolを通じて、OSRSウィキを検索し、ゲームデータ定義にアクセスするためのツールを提供します。

🚀 クイックスタート

このサーバーを使用することで、OSRSウィキの検索やゲームデータの取得が可能になります。以下に各機能の詳細を説明します。

✨ 主な機能

このサーバーは以下のツールを実装しています。

OSRSウィキ関連のメソッド

1. osrs_wiki_search - 検索語に一致するOSRSウィキのページを検索します。
2. osrs_wiki_get_page_info - OSRSウィキの特定のページに関する情報を取得します。
3. osrs_wiki_parse_page - 特定のOSRSウィキページの解析済みHTMLコンテンツを取得します。

ゲームデータ検索メソッド

4. search_varptypes - プレイヤーの状態や進捗を保存するプレイヤー変数 (varps) を varptypes.txt ファイルから検索します。
5. search_varbittypes - varpsから個々のビットを保存する変数ビット (varbits) を varbittypes.txt ファイルから検索します。
6. search_iftypes - ゲームのUIで使用されるインターフェース定義を iftypes.txt ファイルから検索します。
7. search_invtypes - ゲーム内のインベントリタイプ定義を invtypes.txt ファイルから検索します。
8. search_loctypes - ゲーム世界の場所/オブジェクトタイプ定義を loctypes.txt ファイルから検索します。
9. search_npctypes - NPC (非プレイヤーキャラクター) 定義を npctypes.txt ファイルから検索します。
10. search_objtypes - ゲーム内のオブジェクト/アイテム定義を objtypes.txt ファイルから検索します。
11. search_rowtypes - さまざまなインターフェースで使用される行定義を rowtypes.txt ファイルから検索します。
12. search_seqtypes - アニメーションシーケンス定義を seqtypes.txt ファイルから検索します。
13. search_soundtypes - ゲーム内の効果音定義を soundtypes.txt ファイルから検索します。
14. search_spottypes - スポットアニメーション (グラフィカルエフェクト) 定義を spottypes.txt ファイルから検索します。
15. search_spritetypes - インターフェースで使用されるスプライト画像定義を spritetypes.txt ファイルから検索します。
16. search_tabletypes - インターフェースタブ定義を tabletypes.txt ファイルから検索します。

汎用データファイルメソッド

17. search_data_file - データディレクトリ内の任意のファイルから一致するエントリを検索します。
18. get_file_details - データディレクトリ内のファイルに関する詳細を取得します。
19. list_data_files - データディレクトリ内の利用可能なデータファイルを一覧表示します。

📦 インストール

Smitheryを通じたインストール

Smithery を通じてClaude Desktop用の mcp-osrs を自動的にインストールするには、以下のコマンドを実行します。

npx @smithery/cli@latest install @jayarrowz/mcp-osrs --client claude

前提条件

• Node.js (v16以上)
• npmまたはyarn

パッケージのインストール

# リポジトリをクローンします
git clone https://github.com/jayarrowz/mcp-osrs.git
cd mcp-osrs

# 依存関係をインストールします
npm install

# パッケージをビルドします
npm run build

💻 使用例

Claude Desktopでの使用方法

claude_desktop_config.json に以下の内容を追加します。

npxを使用する場合

{
  "mcpServers": {
    "osrs": {
      "command": "npx",
      "args": ["-y", "@jayarrowz/mcp-osrs"]
    }
  }
}

直接Node.jsを使用する場合

{
  "mcpServers": {
    "osrs": {
      "command": "node",
      "args": ["/path/to/mcp-osrs/dist/index.js"]
    }
  }
}

/path/to/mcp-osrs を実際のリポジトリのパスに置き換えてください。

基本的な使用法

OSRSウィキを検索する

// アビッサル鞭に関する情報を検索する
const result = await callTool("osrs_wiki_search", { 
  search: "Abyssal whip" 
});

ページ情報を取得する

// 特定のウィキページに関する情報を取得する
const pageInfo = await callTool("osrs_wiki_get_page_info", { 
  titles: "Abyssal_whip" 
});

ゲームデータを検索する

// オブジェクト定義内のアイテムを検索する
const items = await callTool("search_objtypes", { 
  query: "dragon",
  page: 1,
  pageSize: 10
});

利用可能なデータファイルを一覧表示する

// すべてのデータファイルのリストを取得する
const files = await callTool("list_data_files", {});

🔧 開発

# 依存関係をインストールする
npm install

# 開発モードでサーバーを起動する
npm start

# サーバーをビルドする
npm run build

📄 ライセンス

このMCPサーバーはMITライセンスの下でライセンスされています。これは、MITライセンスの条件に従い、ソフトウェアを自由に使用、変更、配布できることを意味します。詳細については、プロジェクトリポジトリ内の LICENSE ファイルを参照してください。