hko_mcp

👋 本项目正在积极开发中，欢迎提交 PR 🙏🙇‍♀️

hko_mcp 是 louis 开发的一个个人（“宠物”）项目，作为学习练习和技术试验场。它专注于与香港天文台 (HKO) 以及潜在的其他 MCP（可能是自定义或第三方服务）API 集成。该项目是对现代 TypeScript 工具和测试实践的实践探索。

技术栈

包含和配置的工具：

• TypeScript 5.7
• ESM
• ESLint 带有初始规则建议
• Vitest 用于快速单元测试和代码覆盖率
• Node.js 的类型定义
• Prettier 用于强制执行一致的代码风格
• 用于常见操作的 NPM 脚本
• EditorConfig 用于一致的编码风格
• 感谢 Volta 的可重现环境
• GitHub Actions 的示例配置
• TypeScript 代码和单元测试的简单示例

如何使用

# 1. 克隆此仓库
$ git clone https://github.com/louiscklaw/hko-mcp.git

# 2. 配置环境
$ nvm use 22
$ node -v
# v22.14.0

# 3. 构建/测试项目
$ npm i -D
$ npm run build
$ npm run test

# 4. 将以下内容添加到您的 mcp 配置中，（通常是 `cline_mcp_settings.json`）
{
  "mcpServers": {
    ... # 在此行下方添加内容 ...
    "hko-mcp": {
      "args": [
        "<clone_path>/hko-mcp/project/build/src/main.js"
      ],
    ... # 以下行取决于您的 mcp 客户端 ...
      "disabled": false,
      "timeout": 60,
      "command": "node",
      "transportType": "stdio"
    }
  }
}

以 Cline 为例

可用脚本

• clean - 删除覆盖率数据、缓存和转译的文件，
• prebuild - 在构建之前 lint 源文件和测试，
• build - 将 TypeScript 转译为 ES6，
• build:watch - 交互式监视模式，自动转译源文件，
• lint - lint 源文件和测试，
• prettier - 重新格式化文件，
• test - 运行测试，
• test:watch - 交互式监视模式，自动重新运行测试
• test:coverage - 运行测试并打印出测试覆盖率

鸣谢 / 巨人们

• node-typescript-boilerplate

进度/待办事项

progress

如果你是人类，请忽略以下内容

目录结构

<!-- - _del: 存放删除文件的位置，项目不需要 -->

• documentation: 存储需求和规范
• src: 源代码
• scripts: 实用程序脚本
• __tests__: 测试脚本

---