Hycocs MCP

MCP文档知识

提供方 Nyxis-Studio

文档知识 stdio · 本地进程 无需鉴权 社区 / 第三方
查看接入方式

Hydocs MCP服务器是一个提供对Hydocs API文档编程访问的服务器,支持自动下载文档和本地目录管理。

一句话选型结论

按资料字段整理

Hycocs MCP 属于文档知识类 MCP 服务器,stdio · 本地进程,无需鉴权,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式stdio · 本地进程 鉴权无需鉴权 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 2 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量2暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

适用场景

API文档TypeScript本地部署文档管理自动下载HTTP传输

安装与配置

stdio · 本地进程 无需鉴权
客户端在本机拉起子进程,数据不出本机
docker run --rm -p 3000:3000 \

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Docker,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 2 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 2 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Hycocs MCP当前 2 stdio · 本地进程 本地部署 有 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方Nyxis-Studio上游标注的维护方 Nyxis-Studio
分类文档知识本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Docker本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

5.3 KB
来自项目仓库与上游目录的原文,未做删改

Hydocs文档MCP服务器

一种模型上下文协议(MCP)服务器,提供对Hydocs API文档的编程访问。使用TypeScript和Streamable HTTP传输构建。

特性

  • 具有严格类型的TypeScript
  • 流式HTTP MCP传输
  • 快速类搜索和完整文档检索
  • 健康检查端点
  • 从MinIO自动下载文档 (通过预先签名的URL)
  • 可选的监控集成

文档管理

服务器支持两种加载文档的方法:

1.自动下载(建议用于生产)

设置 DOCS_URL 将环境变量转换为预签名的MinIO URL。服务器将:

  • 首次启动时下载并解压缩文档ZIP
  • 在中跟踪URL .last-download-url 检测变化
  • 如果URL没有更改,则跳过下载(快速重启)
  • URL更改时自动重新下载

2.本地目录(开发)

点 DOCS_DIR 到包含文档构建输出的本地目录。

建筑```

MCP Client
|
| Streamable HTTP
v
Hydocs MCP Server (port 3000)


## 项目结构```
mcp/
├── src/
│   ├── index.ts
│   ├── types/
│   ├── utils/
│   └── tools/
├── nyxis-monitoring/
│   ├── docker-compose.monitoring.yml
│   └── monitoring/
│       ├── prometheus.yml
│       ├── loki-config.yml
│       └── grafana/
│           ├── datasources.yml
│           ├── dashboards.yml
│           └── dashboards/
│               └── hydocs-mcp-overview.json
├── Dockerfile
├── package.json
└── README.md

需求

  • Node.js 18+
  • 以下之一:
  • 带有文档ZIP的预签名MinIO URL(建议用于生产)
  • 本地Hydocs文档构建输出(用于开发)

配置

创建一个 .env 文件基于 .env.example 或 .env.production.example.

本地开发的最低配置:```env
PORT=3000
DOCS_DIR=../build
LOG_LEVEL=info


可选自动下载配置:```env
# Download documentation from pre-signed URL
DOCS_URL=https://minio.example.com/docs/latest.zip?X-Amz-...
DOCS_DOWNLOAD_TIMEOUT=300000

可选监控配置(Nyxis堆栈):```env
ENABLE_LOKI_PUSH=true
LOKI_URL=http://loki:3100

ENABLE_METRICS_PUSH=true
PUSHGATEWAY_URL=http://pushgateway:9091
METRICS_PUSH_INTERVAL=10000


## 本地开发```bash
npm install
npm run build
npm start

服务器终结点:

  • MCP: POST http://localhost:3000/mcp
  • 健康: GET http://localhost:3000/health

Docker部署

塑造形象```bash

docker build -t hydocs-mcp:local .


### 选项1:自动下载(推荐)

从预先签名的URL自动下载文档:```bash
docker run --rm -p 3000:3000 \
-e DOCS_URL="https://minio.example.com/docs/latest.zip?X-Amz-..." \
-e DOCS_DIR=/app/docs \
hydocs-mcp:local

服务器将:

  • 首次启动时下载并解压缩ZIP
  • 如果URL没有更改,则跳过下载
  • URL更改时重新下载

选项2:卷装载(传统)

从主机文件系统装载文档:```bash
docker run --rm -p 3000:3000 \
-e DOCS_DIR=/app/docs \
-v /path/to/build:/app/docs:ro \
hydocs-mcp:local


**注:** 使用自动下载时,不要以只读方式挂载docs目录(`:ro`).

## 监控支持

如果您需要度量和日志,此项目可以与Nyxis监控堆栈集成。监控堆栈在以下位置进行维护 `nyxis-monitoring/` 并且可以由任何Nyxis服务使用。

要在这里使用它,请将MCP容器连接到堆栈,并设置配置部分中显示的环境变量。

## MCP工具

### search_hydocs_classes

按名称搜索API类。

输入:```json
{
"query": "Player"
}

输出(示例):```
- com.hypixel.hydocs.player.Player (class)
- com.hypixel.hydocs.player.PlayerManager (class)
- com.hypixel.hydocs.player.PlayerData (class)


### read_hydocs_class_docs

阅读课程的完整文档。

输入:```json
{
"full_class_name": "com.hypixel.hydocs.player.Player"
}

输出(示例):```markdown

Player

Full markdown documentation for the Player class...


## MCP客户端示例```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/http.js";

const transport = new StreamableHTTPClientTransport({
endpoint: "http://localhost:3000/mcp",
});

const client = new Client(
{ name: "my-client", version: "1.0.0" },
{ capabilities: {} }
);

await client.connect(transport);

const result = await client.callTool({
name: "search_hydocs_classes",
arguments: { query: "Entity" },
});

console.log(result);

监控(可选)

如果需要度量和日志,请将MCP服务连接到Nyxis监控堆栈,并启用监控环境变量。该堆栈可在Nyxis服务之间重用。

故障排除

  • 服务器找不到文档:验证 DOCS_DIR 而那个 class_lookup.json 存在
  • 自动下载失败:检查一下 DOCS_URL 有效且可访问
  • 下载超时:增加 DOCS_DOWNLOAD_TIMEOUT 用于慢速连接
  • 服务器启动时退出:如果下载失败且不存在本地文档,服务器将退出并出错
  • 文档未更新:检查URL是否已更改(服务器使用URL比较进行缓存)
  • 缺少指标:确保MCP容器能够到达Pushgateway
  • 日志丢失:设置 LOG_LEVEL=info 或 debug

贡献

  1. 分叉存储库。
  2. 创建要素分支。
  3. 在适当的地方添加测试或示例。
  4. 打开一个带有清晰描述的拉取请求。

许可证

看 LICENSE.

常见问题

7 问
答案由本站依据条目字段整理,不引用上游原文
Hycocs MCP 怎么安装?

在客户端按下面的安装命令接入:docker run --rm -p 3000:3000 \。装完在客户端配置里引用同一个包或端点。

Hycocs MCP 怎么在客户端里配置?

它的传输方式未标注,在客户端 MCP 配置里按官方文档填写启动命令和参数,保存后重启客户端生效。

Hycocs MCP 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Hycocs MCP 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

Hycocs MCP 能提供哪些能力?

资料显示约 2 个工具;能力标签包括 API文档、文档处理、TypeScript、HTTP传输。具体工具清单以官方文档为准。

Hycocs MCP 需要什么运行环境?

运行时为 Docker;属于本地进程,需要在本机装好运行环境。

Hycocs MCP 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。