https://github.com/louiscklaw/hko-mcp
MCP hko tryout
https://github.com/louiscklaw/hko-mcp
mcp mcp-servers
Last synced: 12 days ago
JSON representation
MCP hko tryout
- Host: GitHub
- URL: https://github.com/louiscklaw/hko-mcp
- Owner: louiscklaw
- License: apache-2.0
- Created: 2025-04-01T20:29:40.000Z (18 days ago)
- Default Branch: master
- Last Pushed: 2025-04-07T09:59:31.000Z (13 days ago)
- Last Synced: 2025-04-07T10:33:45.851Z (13 days ago)
- Topics: mcp, mcp-servers
- Language: TypeScript
- Homepage:
- Size: 1000 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-zh - louiscklaw/hko-mcp
README
# hko_mcp
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][typescript] [5.7][typescript-5-7]
- [ESM][esm]
- [ESLint][eslint] with some initial rules recommendation
- [Vitest][vitest] for fast unit testing and code coverage
- Type definitions for Node.js
- [Prettier][prettier] to enforce consistent code style
- NPM [scripts](#available-scripts) for common operations
- [EditorConfig][editorconfig] for consistent coding style
- Reproducible environments thanks to [Volta][volta]
- Example configuration for [GitHub Actions][gh-actions]
- Simple example of TypeScript code and unit test
## How to use
```bash
# 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": [
"/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
- `documentation`: store requirements and specifications
- `src`: source code
- `scripts`: utilities script
- `__tests__`: test script
---
[progress]: https://github.com/louiscklaw/hko-mcp/blob/master/documentation/progress.md
[typescript]: https://www.typescriptlang.org/
[typescript-5-7]: https://devblogs.microsoft.com/typescript/announcing-typescript-5-7/
[eslint]: https://github.com/eslint/eslint
[prettier]: https://prettier.io
[volta]: https://volta.sh
[gh-actions]: https://github.com/features/actions
[esm]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[editorconfig]: https://editorconfig.org
[vitest]: https://vitest.dev
[node-typescript-boilerplate]: https://github.com/jsynowiec/node-typescript-boilerplate