金大哥 - mcp-osrs MCP 详情

article

README

🚀 OSRS MCP 服务器

这是一个用于与《oldschool runescape》（OSRS）维基 API 和数据文件交互的 MCP 服务器。它提供了搜索 OSRS 维基和访问游戏数据定义的工具，方便开发者获取游戏相关信息。

🚀 快速开始

此服务器提供了丰富的工具来与 OSRS 维基和游戏数据文件进行交互，下面将详细介绍这些工具。

✨ 主要特性

工具列表

此服务器实现了以下工具：

OSRS 维基方法

osrs_wiki_search - 在 OSRS 维基中搜索与查询词匹配的页面
osrs_wiki_get_page_info - 获取特定 OSRS 维基页面的信息
osrs_wiki_parse_page - 获取特定 OSRS 维基页面的解析 HTML 内容

游戏数据搜索方法

search_varptypes - 搜索 varptypes.txt 文件以查找存储玩家状态和进度的变量（varps）
search_varbittypes - 搜索 varbittypes.txt 文件以查找来自 varps 的单独位（varbits）
search_iftypes - 搜索 iftypes.txt 文件以查找游戏界面定义
search_invtypes - 搜索 invtypes.txt 文件以查找游戏库存类型定义
search_loctypes - 搜索 loctypes.txt 文件以查找游戏世界中的位置/对象类型定义
search_npctypes - 搜索 npctypes.txt 文件以查找非玩家角色（NPC）定义
search_objtypes - 搜索 objtypes.txt 文件以查找物品定义
search_searchtypes - 搜索 searchtypes.txt 文件以查找可搜索的物体定义
search_groundtypes - 搜索 groundtypes.txt 文件以查找地面物体定义

数据文件方法

list_data_files - 获取所有可用数据文件的列表
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"
}

开发

# 安装依赖项
npm install

# 在开发模式下启动服务器
npm start

# 构建服务器
npm run build

💻 使用示例

基础用法

搜索物品

// 搜索特定物品
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"
});

📄 许可证

此 MCP 服务器根据 MIT 许可证发布。这意味着您可以自由使用、修改和分发软件，但需遵守 MIT 许可证的条款和条件。有关详细信息，请参阅项目存储库中的 LICENSE 文件。

mcp-osrs