🚀 OSRS MCP 服务器
OSRS MCP 服务器用于与旧版《符文传奇》（OSRS）维基 API 和数据文件进行交互。该服务器提供了搜索 OSRS 维基和通过模型上下文协议访问游戏数据定义的工具。
🚀 快速开始
本部分将介绍 OSRS MCP 服务器的工具、安装、使用示例、开发相关内容以及许可证信息。
✨ 主要特性
该服务器实现了以下工具：
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 文件中搜索游戏 UI 中使用的界面定义。search_invtypes- 在 invtypes.txt 文件中搜索游戏中的库存类型定义。search_loctypes- 在 loctypes.txt 文件中搜索游戏世界中的位置/对象类型定义。search_npctypes- 在 npctypes.txt 文件中搜索非玩家角色（NPC）定义。search_objtypes- 在 objtypes.txt 文件中搜索游戏中的对象/物品定义。search_rowtypes- 在 rowtypes.txt 文件中搜索各种界面中使用的行定义。search_seqtypes- 在 seqtypes.txt 文件中搜索动画序列定义。search_soundtypes- 在 soundtypes.txt 文件中搜索游戏中的音效定义。search_spottypes- 在 spottypes.txt 文件中搜索点动画（图形效果）定义。search_spritetypes- 在 spritetypes.txt 文件中搜索界面中使用的精灵图像定义。search_tabletypes- 在 tabletypes.txt 文件中搜索界面标签定义。
通用数据文件方法
search_data_file- 在数据目录中的任何文件中搜索匹配的条目。get_file_details- 获取数据目录中文件的详细信息。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
💻 使用示例
基础用法
搜索 OSRS 维基
// 搜索关于 Abyssal whip 的信息
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", {});
📚 详细文档
与 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 替换为您仓库的实际路径。
🔧 技术细节
开发
# 安装依赖
npm install
# 在开发模式下启动服务器
npm start
# 构建服务器
npm run build
📄 许可证
本 MCP 服务器采用 MIT 许可证。这意味着您可以自由使用、修改和分发该软件，但需遵守 MIT 许可证的条款和条件。更多详细信息，请参阅项目仓库中的 LICENSE 文件。