@softspark/jira-mcp 1.1.0 → 1.3.0

package/CHANGELOG.md

@@ -7,6 +7,39 @@ Versioning follows [Semantic Versioning](https://semver.org/).
 
 ---
 
+## v1.3.0 -- File-Backed Templates & Approval Hooks (2026-04-15)
+
+### Added
+- **File-backed template catalog** -- ship built-in comment and single-task templates as physical markdown files under `templates-system/`.
+- **Template management CLI** -- add `jira-mcp template add/list/show/remove` for global user overrides in `~/.softspark/jira-mcp/templates/`.
+- **Task templates for `create_task`** -- add `list_task_templates` and template-based issue creation with variable rendering.
+- **Comment approval hook manifest** -- ship `hooks/jira-mcp-hooks.json` for ai-toolkit `inject-hook` flows that preview and gate Jira comment writes.
+
+### Changed
+- **Template loading model** -- resolve active templates from system files plus global user overrides, with user files winning on `id` collisions.
+- **Configuration init** -- create dedicated template directories for comments, single-task templates, and bulk task configs.
+- **README validation** -- exclude internal tool helpers from MCP tool counts and refresh counts to match the current source tree.
+
+### Fixed
+- **Comment write safety** -- require explicit `user_approved=true` before `add_task_comment` and `add_templated_comment` can mutate Jira.
+- **Comment preview flow** -- render templated comment previews before execution so approval can target the exact outgoing markdown.
+
+## v1.2.0 -- Per-Instance Credentials & Jira API Migration (2026-04-14)
+
+### Added
+- **Per-instance credentials** -- `set-credentials --url` flag allows different API tokens per Jira instance. Auto-migrates legacy Format A to Format B on first use.
+- **Live Jira API smoke tests** -- post-release SOP now includes Phase 4 with 15 steps testing all MCP tools against the KAN sandbox project.
+- **`validate_counts.py` in pre-commit SOP** -- added as Step 5 to catch README count drift before commit.
+
+### Changed
+- **Search endpoint migrated** -- `/rest/api/3/search` → `/rest/api/3/search/jql` (Jira Cloud deprecated the old endpoint with HTTP 410).
+- **`set-credentials` CLI** -- read-modify-write instead of overwrite. Preserves existing credentials when adding instance overrides.
+
+### Fixed
+- **Jira Cloud 410 on sync/search** -- `sync_tasks` and `search_tasks` failed on instances where Jira had removed the legacy search endpoint.
+
+---
+
 ## v1.1.0 -- Hardening & Market Readiness (2026-04-14)
 
 ### Added

package/README.md

@@ -4,19 +4,18 @@
 
 [![CI](https://github.com/softspark/jira-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/softspark/jira-mcp/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/@softspark/jira-mcp)](https://www.npmjs.com/package/@softspark/jira-mcp)
-[![version](https://img.shields.io/badge/version-1.1.0-blue)](CHANGELOG.md)
+[![version](https://img.shields.io/badge/version-1.3.0-blue)](CHANGELOG.md)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
 ---
 
-## What's New in v1.1.0
+## What's New in v1.3.0
 
-- **Hardening & market readiness** -- boundary tests, retry/backoff, security fixes, server refactor.
-- **509 tests** across 51 test files -- boundary tests for `server.ts`, CLI bootstrap, and `JiraConnector` (96 new tests).
-- **Retry/backoff** -- transient Jira API failures (429, 503) retried up to 3x with exponential backoff.
-- **server.ts refactored** -- 719 → 324 lines. Tool definitions and argument helpers extracted to dedicated modules.
-- **Major dep upgrades** -- TypeScript 6, ESLint 10, zod 4, vitest 4.
-- **Security hardened** -- cache 0o600, CWD config warning, error truncation, count validation in CI.
+- **File-backed templates** -- built-in comment and task templates now live as physical markdown files and support global user overrides.
+- **Template CLI + `create_task` templates** -- add install/list/show/remove flows and first-class task template rendering.
+- **Comment approval hooks** -- ship a repo-owned ai-toolkit hook manifest that previews Jira comments before the write executes.
+- **Runtime approval enforcement** -- block comment mutations unless the retry includes `user_approved=true`.
+- **541 tests** across 56 test files.
 
 See [CHANGELOG.md](CHANGELOG.md) for full details.
 
@@ -76,6 +75,10 @@ All configuration lives in `~/.softspark/jira-mcp/` (created by `jira-mcp config
 | `jira-mcp serve` | Start MCP server (explicit) |
 | `jira-mcp create <path>` | Create tasks from config file (dry-run by default) |
 | `jira-mcp create-monthly` | Create monthly admin tasks from built-in templates |
+| `jira-mcp template add <type> <path>` | Install a template override from a local markdown file |
+| `jira-mcp template list [type]` | List active comment/task templates |
+| `jira-mcp template show <type> <id>` | Show the active template file content |
+| `jira-mcp template remove <type> <id>` | Remove a user-installed template override |
 | `jira-mcp config init` | Initialize global config at `~/.softspark/jira-mcp/` |
 | `jira-mcp config add-project <key> <url>` | Add a Jira project to config |
 | `jira-mcp config remove-project <key>` | Remove a project from config |
@@ -97,7 +100,7 @@ All configuration lives in `~/.softspark/jira-mcp/` (created by `jira-mcp config
 | `read_cached_tasks` | Read tasks from cache without hitting Jira | `task_key?` |
 | `update_task_status` | Change task status via workflow transition | `task_key`, `status` |
 | `update_task` | Update existing issue fields (markdown → ADF) | `task_key`, `summary?`, `description?`, `priority?`, `labels?` |
-| `add_task_comment` | Add a markdown comment (auto-converted to ADF) | `task_key`, `comment` |
+| `add_task_comment` | Add a markdown comment (auto-converted to ADF) | `task_key`, `comment`, `user_approved` |
 | `reassign_task` | Reassign or unassign a task | `task_key`, `assignee_email?` |
 | `get_task_statuses` | Get valid workflow transitions for a task | `task_key` |
 | `get_task_details` | Get full details with description, comments, and language | `task_key` |
@@ -105,8 +108,9 @@ All configuration lives in `~/.softspark/jira-mcp/` (created by `jira-mcp config
 | `log_task_time` | Log work time (`"2h 30m"` format, no days) | `task_key`, `time_spent`, `comment?` |
 | `get_task_time_tracking` | Get time tracking info (estimate, spent, remaining) | `task_key` |
 | `list_comment_templates` | List available comment templates | `category?` |
-| `add_templated_comment` | Add comment using a template or raw markdown | `task_key`, `template_id?`, `variables?`, `markdown?` |
-| `create_task` | Create a new Jira issue with ADF description | `project_key`, `summary`, `description?`, `assignee_email?`, `labels?`, `epic_key?` |
+| `list_task_templates` | List available task templates for `create_task` | — |
+| `add_templated_comment` | Add comment using a template or raw markdown | `task_key`, `template_id?`, `variables?`, `markdown?`, `user_approved` |
+| `create_task` | Create a new Jira issue with explicit fields or a task template | `project_key`, `summary?`, `template_id?`, `variables?`, `description?`, `assignee_email?`, `labels?`, `epic_key?` |
 | `search_tasks` | Search Jira issues with JQL (no caching) | `jql`, `max_results?`, `project_key?` |
 
 ## Comment Templates
@@ -132,6 +136,23 @@ Example with Claude Code:
 
 The AI will use `add_templated_comment` with `template_id: "status-update"` automatically.
 
+### File-Backed Overrides
+
+System templates are shipped as markdown files. User overrides are loaded from:
+
+```text
+~/.softspark/jira-mcp/templates/comments/
+~/.softspark/jira-mcp/templates/task-templates/
+```
+
+If a user file has the same `id` as a system template, the user file wins globally for all projects.
+
+```bash
+jira-mcp template add comment ./my-status-update.md
+jira-mcp template add task ./my-bug-task.md
+jira-mcp template list
+```
+
 ## Usage with Claude Code
 
 Add to your Claude Code MCP configuration (`~/.claude/claude_desktop_config.json` or project-level):
@@ -162,7 +183,19 @@ Or copy `rules/jira-mcp.md` to your ai-toolkit rules directory manually. The rul
 - **Sync before read** -- cache may be stale
 - **Status transitions** -- check valid transitions before changing status
 - **Time format** -- `"2h 30m"`, never days
-- **All 15 MCP tools** and **16 CLI commands** reference
+- **All 16 MCP tools** and **20 CLI commands** reference
+
+### AI Toolkit Hooks
+
+To require explicit user approval before Jira comment writes, inject the repo-owned hook manifest:
+
+```bash
+ai-toolkit inject-hook https://raw.githubusercontent.com/softspark/jira-mcp/main/hooks/jira-mcp-hooks.json
+```
+
+This installs a `PreToolUse` guard for `add_task_comment` and `add_templated_comment`. The hook blocks the tool call, shows the exact comment preview, and tells the agent to retry only after the user approves it with `user_approved=true`.
+
+The MCP server still enforces `user_approved=true` at runtime, so the hook is UX guidance plus an extra safety layer rather than the only check.
 
 ## Usage with Other MCP Clients
 
@@ -189,14 +222,15 @@ src/
     commands/
       cache/      Cache management subcommands
       config/     Config management subcommands
+      template/   File-backed template management subcommands
       create.ts   Bulk task creation command
       create-monthly.ts  Monthly admin task automation
   config/         Configuration loading and Zod validation
   connector/      Jira API client (built-in fetch, instance pool)
   errors/         Typed error hierarchy
   operations/     Business logic (status, comments, time tracking)
-  templates/      Comment template system (registry + built-in templates)
-  tools/          MCP tool handlers (15 tools, one file per tool)
+  templates/      File-backed comment/task template loading and registries
+  tools/          MCP tool handlers (16 tools, one file per tool)
   types/          Shared TypeScript types
   server.ts       MCP server setup and tool registration
   cli.ts          CLI entry point
@@ -210,7 +244,7 @@ src/
 
 **Local caching** -- tasks synced to `~/.softspark/jira-mcp/cache/` with atomic writes (tmp + rename). Work offline with `read_cached_tasks`, sync on demand. Workflow and user caches for status validation and assignee resolution.
 
-**Comment templates** -- 8 built-in templates with `{{variable}}` interpolation and `{{#var}}...{{/var}}` conditional blocks. Status updates, blockers, handoffs, reviews. See [Templates Reference](kb/reference/templates.md).
+**File-backed templates** -- 8 built-in comment templates and built-in task templates are stored as markdown files, with global user overrides loaded from `~/.softspark/jira-mcp/templates/`. Both support `{{variable}}` interpolation and `{{#var}}...{{/var}}` conditional blocks. See [Templates Reference](kb/reference/templates.md).
 
 **Language configuration** -- global `default_language` with per-project override. Supports: pl, en, de, es, fr, pt, it, nl. `get_project_language` tool and `language` field in `get_task_details` let AI assistants write content in the correct language. See [Configuration](kb/reference/configuration.md).
 
@@ -220,16 +254,16 @@ src/
 
 **Supply chain protection** -- `ignore-scripts=true`, no axios, no dynamic requires. Self-contained 520KB bundle, 1 runtime dep (commander).
 
-**Typed error hierarchy** -- 15 error classes with machine-readable codes. Every tool returns structured `{ success, error, code }` responses. No stack traces leak to MCP clients.
+**Typed error hierarchy** -- 17 error classes with machine-readable codes. Every tool returns structured `{ success, error, code }` responses. No stack traces leak to MCP clients.
 
-**Strict TypeScript** -- `strict: true`, no `any`, `readonly` interfaces, Zod validation at all boundaries, 509 tests across 51 test files. Self-contained 520KB package.
+**Strict TypeScript** -- `strict: true`, no `any`, `readonly` interfaces, Zod validation at all boundaries, 541 tests across 56 test files. Self-contained 520KB package.
 
 ## Documentation
 
 | Document | Description |
 |----------|-------------|
 | [Architecture](kb/reference/architecture.md) | System design and module overview |
-| [API Reference](kb/reference/api.md) | All 15 MCP tools with schemas |
+| [API Reference](kb/reference/api.md) | All 16 MCP tools with schemas |
 | [Configuration](kb/reference/configuration.md) | Config files, env vars, multi-instance |
 | [ADF Format](kb/reference/adf.md) | Atlassian Document Format conversion |
 | [Caching](kb/reference/caching.md) | Task, workflow, and user caching |