Minestom MCP服务器

一个基于Model Context Protocol SDK和TanStack AI工具定义实现的Minestom标准输入输出MCP服务器。

  • by RonaldBunk
  • TypeScript
  • 本地部署
  • 5 星标
  • 更新于
在 GitHub 查看 Azoraqua/minestom-mcp-server

使用说明

Minestom MCP服务器

Minestom的stdio MCP服务器,使用模型上下文协议SDK和TanStack AI工具定义实现。

安装

首选包调用:

npx -y minestom-mcp

通常是一个类似的文件 .mcp.json 在您的项目根目录下,代理将拾取:

{
  "mcpServers": {
    "minestom-mcp": {
      "command": "npx",
      "args": ["-y", "minestom-mcp"]
    }
  }
}

已安装的命令别名:

minestom-mcp-server
minestom-mcp

为什么这个形状:

  • minestom-mcp-server 是npm包名称,也是最安全的 npx 入口点。
  • minestom-mcp 是安装后较短的命令别名。
  • npm npx 当以下情况之一发生时,解析匹配的bin bin 条目与包名称匹配,因此将包发布为 minestom-mcp-server 带着一个 minestom-mcp-server 垃圾桶 npx -y minestom-mcp-server 可靠。来源: npm npx文档

刀具表面接地:

详细的工具文档位于 docs/tools.md.

该存储库还提供了一个可发布的静态文档站点 docs/ 加上GitHub Pages工作流 /.github/workflows/deploy-docs.yml.

社区和贡献文档居住 贡献.md, 代码_OF_CONDUCT.md,以及 安全.md.

工具

  • ping:验证MCP服务器是否可访问。
  • get_server_info:返回包元数据、运行时详细信息、工具清单和知识目录覆盖率。
  • inspect_minestom_environment:检查当前工作区或 repoRoot,包括子目录、Gradle/Maven构建信号、JVM源代码布局、检测到的模式、入口点、现有库以及任何检测到的 run/ 文件夹。
  • inspect_minestom_build:解释Gradle或Maven模块,包括依赖关系、插件、包装器命令、变量/属性和Gradle版本目录。
  • explain_minestom_pattern:解释了Minestom的引导、实例、事件、命令、调度器和线程所有权模式。
  • lookup_minestom_api:返回经过策划的API匹配,包括包名称、相关API和javadoc链接。
  • plan_minestom_feature:为Minestom功能类型生成一个可靠的实现大纲。
  • review_minestom_design:根据Minestom的管理器、事件、实例、调度器和线程模式审查设计说明。
  • suggest_minestom_libraries:返回经过策划的库建议,可以选择添加实时GitHub主题结果,现在使用可用的存储库信号。

备注

  • API查找是围绕最重要的Minestom符号和图案策划的;它不是一个完整的javadoc爬虫。
  • 库发现是混合的:策划的结果总是首先返回,实时GitHub topic:minestom-library 搜索是可选的,支持仓库的排名可以检查目标项目。
  • 环境感知工具默认为当前工作目录,并检查作为该工作区一部分的子目录。你可以通过 repoRoot 检查不同的Minestom工作空间,以及 run/ 被视为强烈的开发信号,而不是假定的服务器根。
  • 因为Minestom是基于JVM的,所以在将工作区视为可能的Minestom服务器项目之前,环境扫描会明确地查找Gradle/Maven构建文件、通用包装器脚本、JVM源代码根和Java/Kotlin信号。
  • 构建感知检查了解常见的Gradle依赖关系/插件声明 build.gradle 或 build.gradle.kts,读 gradle/libs.versions.toml,并解析Maven pom.xml 依赖关系、插件和属性。

发展

pnpm install
pnpm dev
pnpm lint:fix
pnpm check

赫斯基在以下时间安装本地挂钩 pnpm install.提交运行 lint-staged,并推动跑完全程 pnpm check 验证流程。

发布

该包已设置为使用npm发布:

  • 可执行文件箱 minestom-mcp-server 和 minestom-mcp
  • shebang包含捆绑式入口 dist/server.js
  • files 发布tarball的白名单
  • prepack 和 prepublishOnly 验证挂钩
  • GitHub操作发布自 .github/workflows/npm-publish.yml 通过pnpm安装/检查步骤和npm可信发布
  • publishConfig.access = public

推荐释放流程:

pnpm check
npm pack --dry-run
npm publish

对于npm可信发布,配置npm信任工作流文件名 npm-publish.yml 在 .github/workflows/工作流程现在使用pnpm 安装并验证依赖关系,然后发布 npm publish 通过GitHub Actions OIDC而不是长期使用 NPM_TOKEN.