MCP Osrs

🚀 OSRS MCP サーバー

このサーバーは、《oldschool runescape》（OSRS）のウィキ API とデータファイルとの相互作用を可能にする MCP サーバーです。OSRS ウィキの検索やゲームデータ定義へのアクセスを行うためのツールを提供します。

🚀 クイックスタート

このサーバーは、OSRS ウィキ API とデータファイルとのやり取りを容易にするためのものです。以下では、その機能やインストール方法、使用例などを説明します。

✨ 主な機能

OSRS ウィキ関連のメソッド

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

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

4. search_varptypes - varptypes.txt ファイルを検索し、プレイヤーの状態や進捗を保存する変数（varps）を探します。
5. search_varbittypes - varbittypes.txt ファイルを検索し、varps からの個別のビット（varbits）を探します。
6. search_iftypes - iftypes.txt ファイルを検索し、ゲームのインターフェイス定義を探します。
7. search_invtypes - invtypes.txt ファイルを検索し、ゲームのインベントリタイプ定義を探します。
8. search_loctypes - loctypes.txt ファイルを検索し、ゲームワールド内の位置やオブジェクトタイプ定義を探します。
9. search_npctypes - npctypes.txt ファイルを検索し、非プレイヤーキャラクター（NPC）の定義を探します。
10. search_objtypes - objtypes.txt ファイルを検索し、アイテムの定義を探します。
11. search_searchtypes - searchtypes.txt ファイルを検索し、検索可能な物体の定義を探します。
12. search_groundtypes - groundtypes.txt ファイルを検索し、地面の物体定義を探します。

データファイル関連のメソッド

13. list_data_files - 利用可能なすべてのデータファイルのリストを取得します。
14. get_file_info - 特定のファイルの情報を取得します。

📦 インストール

Smithery を使用したインストール

# 使用 Smithery 进行安装

手動インストール

# 依存関係のインストール
npm install

# サーバーのビルド
npm run build

# サーバーの起動（開発モード）
npm start

📚 ドキュメント

設定

config.json ファイルに以下の設定を追加します。

{
  "wiki apiUrl": "https://oldschool.runescape.wiki/api.php",
  "wiki username": "your-wiki-username",
  "wiki password": "your-wiki-password"
}

💻 使用例

基本的な使用法

アイテムの検索

// 特定のアイテムを検索します。
const items = await callTool("search_objtypes", { 
  query: "dragon",
  page: 1,
  pageSize: 10
});

ファイル情報の取得

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

// 特定のファイルの情報を取得します。
const fileInfo = await callTool("get_file_info", {
  file: "objtypes.json"
});

🔧 技術詳細

開発手順

# 依存関係のインストール
npm install

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

# サーバーのビルド
npm run build

📄 ライセンス

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