mcp-clickhousex: Instructions file for Codex

Agent Instructions

Rules AI agents must follow when working in this repository.

---

Commit messages

Use Conventional Commits.

Header

• Format: <type>(optional scope): summary
• Use lowercase types (feat, fix, ci, chore, docs)
• Use scopes when relevant
• Write summaries in lowercase, imperative mood

Body

• Leave a blank line after the header
• Explain why, not what
• Use imperative, present tense
• Wrap lines at ~72 characters

The body is optional for trivial changes.

---

Commits

When generating commits via a shell:

• Do not pass generated messages directly to git commit -m
• Write the commit message to a file or standard input
• Use git commit -F <file> or git commit -F -
• Disable shell expansion when writing commit messages

This avoids issues with backticks, quotes, and other shell-expanded characters in generated commit messages.

---

Release tags

• Use the bare version as the tag name — no v prefix (e.g. 0.1.0a4, not v0.1.0a4)
• Tags must be annotated (git tag -a) with a structured release-notes message
• CI verifies the tag against pyproject.toml and server.json before it publishes anything; a mismatch — a v prefix included — fails the build rather than being silently rewritten

---

Attribution

Every AI-assisted commit, tag, PR, comment, reply, or message an agent writes for someone must carry an Assisted-by trailer:

Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2]

Field	Description
AGENT_NAME	AI tool or framework (e.g. Claude, Cursor, Copilot)
MODEL_VERSION	Specific model (e.g. claude-opus-4-6)
[TOOL1] [TOOL2]	Optional specialized analysis tools; omit everyday tools

• Place it at the end, after a blank line: a git trailer in commits, the last line of the body everywhere else.
• Skip it only for text the user dictates verbatim.
• Use only Assisted-by — no Co-Authored-By, no Made with …, no hand-written Sent using …, no other footers.