From ace36d19863bdc98436ecdd4b6aa5c06476e015b Mon Sep 17 00:00:00 2001 From: Jonathan Miller Date: Sun, 10 May 2026 19:55:24 +0000 Subject: [PATCH] docs: add CLAUDE.md for Claude Code context [skip ci] --- CLAUDE.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..30bb683 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,50 @@ +# CLAUDE.md + +This file provides guidance to Claude Code when working with this repository. + +## Project Overview + +**Template-MCP** -- Template repository for creating MokoStandards-compliant MCP API servers + +| Field | Value | +|---|---| +| **Platform** | mcp-server | +| **Language** | TypeScript | +| **Default branch** | main | +| **License** | GPL-3.0-or-later | +| **Wiki** | [Template-MCP Wiki](https://git.mokoconsulting.tech/MokoConsulting/Template-MCP/wiki) | +| **Standards** | [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home) | + +## Common Commands + +```bash +make build # Build the project +make lint # Run linters +make validate # Validate structure +make release # Full release pipeline +make minify # Minify CSS/JS assets +make clean # Clean build artifacts +``` + +```bash +npm install # Install dependencies +npm run build # Compile TypeScript +npm run dev # Development mode +``` + +## Architecture + +This is an MCP (Model Context Protocol) server. Key files: +- `src/index.ts` -- server entry point and tool registration +- `src/config.ts` -- configuration loading +- `src/tools/` -- individual tool implementations +- `dist/` -- compiled output (gitignored) + +## Rules + +- **Never commit** `.claude/`, `.mcp.json`, `TODO.md`, or `*.min.css`/`*.min.js` +- **Attribution**: use `Authored-by: Moko Consulting` in commits +- **Branch strategy**: develop on `dev`, merge to `main` for release +- **Minification**: handled at build time (CI) and runtime (MokoMinifyHelper for Joomla templates) +- **Wiki**: documentation lives in the Gitea wiki, not in `docs/` files +- **Standards**: this repo follows [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)