summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-02-10 19:28:27 +0200
committerPaul Buetow <paul@buetow.org>2026-02-10 19:28:27 +0200
commit5551695f3b0d10c9a22cfacdb10c2cf7bd572421 (patch)
tree282611eacf1fd4c38d54d5cea87decdf2b1cbdb7 /README.md
parentec745129258ae800065e302a2a40b54488cbca08 (diff)
Add MCP server implementation with comprehensive test coverage
Implements a full Model Context Protocol (MCP) server for managing and serving prompts to LLM applications. The server provides CRUD operations for prompts with automatic backups and template rendering support. Key additions: - cmd/hexai-mcp-server: Main MCP server binary entrypoint - internal/hexaimcp: Server orchestrator with configuration and setup - internal/mcp: Core MCP protocol implementation (JSON-RPC 2.0) - internal/promptstore: Prompt storage with JSONL backend and automatic backups - Comprehensive test suites achieving 80%+ coverage for all MCP packages - Magefile targets for building and installing the MCP server - Complete documentation for setup, API, prompts, and backups Test coverage: - internal/hexaimcp: 84.3% - internal/mcp: 80.3% - internal/promptstore: 81.2% - Overall project: 81.5% Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index efb9b0c..5a6417b 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,12 @@ It has got improved capabilities for Go code understanding (for example, create
* LSP in-editor chat with the LLM
* Stand-alone command line tool for LLM interaction
* Parallel completions and CLI responses from multiple providers/models for side-by-side comparison
+* **MCP server for prompt/runbook management** (`hexai-mcp-server`)
+ - Create, update, delete, and retrieve prompts via MCP protocol
+ - Automatic backups on every change (keeps last 10)
+ - Compatible with Claude Code CLI, Cursor, and other MCP clients
+ - File-based storage with JSONL format (git-friendly)
+ - Built-in prompts for code review, testing, documentation, etc.
* TUI AI code-action runner (`hexai-tmux-action`) with Bubble Tea
- Includes a "Custom prompt" action (hotkey `p`) that opens your editor (`$HEXAI_EDITOR` or `$EDITOR`) on a temporary Markdown file.
* Tmux popup editor (`hexai-tmux-edit`) for composing longer AI agent prompts
@@ -27,6 +33,8 @@ It has got improved capabilities for Go code understanding (for example, create
* [Configuration guide](docs/configuration.md)
* [Usage examples](docs/usage.md)
* [Helix + tmux quickstart](docs/tmux.md)
+* [MCP server setup guide](docs/mcp-setup.md)
+* [Creating custom prompts](docs/mcp-prompts.md)
## Tmux Status Line
@@ -46,5 +54,9 @@ hexai follows the XDG Base Directory Specification:
- `tmux-edit-history.jsonl` - History of text submitted via tmux popup
- `hexai-lsp.log` - LSP server debug logs
- `hexai-tmux-edit.log` - Tmux edit debug logs
+ - `hexai-mcp-server.log` - MCP server debug logs
+- **Data:** `~/.local/share/hexai/` (or `$XDG_DATA_HOME/hexai/`)
+ - `prompts/default.jsonl` - Built-in prompts for MCP server
+ - `prompts/user.jsonl` - User-created custom prompts
- **Temporary Files:** `/tmp/` (OS temp directory)
- `hexai-*.md` - Temporary editor workspaces (auto-deleted)