hko_mcp

👋 This project is in active development, PRs are welcomed 🙏🙇‍♀️

hko_mcp is a personal ("pet") project developed by louis as a learning exercise and technical playground. It focuses on integrating with the Hong Kong Observatory (HKO) and potentially other MCP (possibly a custom or third-party service) APIs. The project serves as a hands-on exploration of modern TypeScript tooling and testing practices.

Technical Stack

tools included and configured:

• TypeScript 5.7
• ESM
• ESLint with some initial rules recommendation
• Vitest for fast unit testing and code coverage
• Type definitions for Node.js
• Prettier to enforce consistent code style
• NPM scripts for common operations
• EditorConfig for consistent coding style
• Reproducible environments thanks to Volta
• Example configuration for GitHub Actions
• Simple example of TypeScript code and unit test

How to use

# 1. clone this repo
$ git clone https://github.com/louiscklaw/hko-mcp.git

# 2. configure environment
$ nvm use 22
$ node -v
# v22.14.0

# 3. build / test project
$ npm i -D
$ npm run build
$ npm run test

# 4. add below to your mcp configuration, (usually `cline_mcp_settings.json`)
{
  "mcpServers": {
    ... # add the thins below this line ...
    "hko-mcp": {
      "args": [
        "<clone_path>/hko-mcp/project/build/src/main.js"
      ],
    ... # line below are subject to your mcp client ...
      "disabled": false,
      "timeout": 60,
      "command": "node",
      "transportType": "stdio"
    }
  }
}

take Cline for example

Available Scripts

• clean - remove coverage data, cache and transpiled files,
• prebuild - lint source files and tests before building,
• build - transpile TypeScript to ES6,
• build:watch - interactive watch mode to automatically transpile source files,
• lint - lint source files and tests,
• prettier - reformat files,
• test - run tests,
• test:watch - interactive watch mode to automatically re-run tests
• test:coverage - run test and print out test coverage

Credits / Giants

• node-typescript-boilerplate

PROGRESS/TODO

progress

if you are human, please ignore the things below

Directory structure

<!-- - _del: place to store delete files, no need for project -->

• documentation: store requirements and specifications
• src: source code
• scripts: utilities script
• __tests__: test script

---