Documentation Generator MCP Server

{ "$schema": "./schema.json", "project": "docs-mcp", "changelog_version": "1.0", "current_version": "1.4.8", "entries": [ { "version": "1.4.8", "date": "2025-10-13", "summary": "Version 1.4.8 changes", "changes": [ { "id": "change-026", "type": "enhancement", "severity": "patch", "title": "Test AI Normalization After Server Restart", "description": "Test entry to verify AI name normalization is working after server restart.", "files": [ "test_restart.py" ], "reason": "Testing the AI contributor naming system after server restart.", "impact": "Testing the AI contributor naming system after server restart to confirm normalization is working.", "breaking": false } ], "contributors": [ "claude", "chatgpt", "gemini", "cursor", "copilot" ] }, { "version": "1.4.7", "date": "2025-10-13", "summary": "Version 1.4.7 changes", "changes": [ { "id": "change-025", "type": "enhancement", "severity": "patch", "title": "Test Fixed Contributors Assignment", "description": "Test after fixing the contributors assignment logic.", "files": [ "test_file7.py" ], "reason": "Testing after fixing the contributors assignment logic.", "impact": "Testing after fixing the contributors assignment logic.", "breaking": false } ], "contributors": [ "claude", "chatgpt" ] }, { "version": "1.4.6", "date": "2025-10-13", "summary": "Version 1.4.6 changes", "changes": [ { "id": "change-024", "type": "enhancement", "severity": "patch", "title": "Debug Normalization Test", "description": "Test with debug output to see what's happening with normalization.", "files": [ "test_file6.py" ], "reason": "Testing with debug output to identify the normalization issue.", "impact": "Testing with debug output to identify normalization issue.", "breaking": false } ], "contributors": [ "claude", "chatgpt" ] }, { "version": "1.4.5", "date": "2025-10-13", "summary": "Version 1.4.5 changes", "changes": [ { "id": "change-023", "type": "enhancement", "severity": "patch", "title": "Test After Indentation Fix", "description": "Test after fixing indentation error in changelog generator.", "files": [ "test_file5.py" ], "reason": "Testing after fixing indentation error.", "impact": "Testing the changelog generator after fixing the indentation error.", "breaking": false } ], "contributors": [ "claude", "chatgpt", "gemini" ] }, { "version": "1.4.4", "date": "2025-10-13", "summary": "Version 1.4.4 changes", "changes": [ { "id": "change-022", "type": "enhancement", "severity": "patch", "title": "Test Fixed AI Name Normalization", "description": "Test after fixing normalization logic for new version entries.", "files": [ "test_file4.py" ], "reason": "Testing the fixed normalization logic.", "impact": "Testing the fixed AI contributor naming system for new version entries.", "breaking": false } ], "contributors": [ "claude", "chatgpt", "gemini" ] }, { "version": "1.4.3", "date": "2025-10-13", "summary": "Version 1.4.3 changes", "changes": [ { "id": "change-021", "type": "enhancement", "severity": "patch", "title": "Final AI Name Normalization Test", "description": "Final test to verify AI name normalization is working correctly.", "files": [ "test_file3.py" ], "reason": "Final test of the AI contributor naming system.", "impact": "Final verification that the AI contributor naming system works correctly.", "breaking": false } ], "contributors": [ "claude", "chatgpt", "gemini" ] }, { "version": "1.4.2", "date": "2025-10-13", "summary": "Version 1.4.2 changes", "changes": [ { "id": "change-018", "type": "enhancement", "severity": "minor", "title": "Implement Standardized AI Contributor Naming System", "description": "Implemented standardized AI contributor naming system for changelog entries. Added AIContributorNames class with normalization logic, updated schema with naming guidelines, and enhanced changelog generator to automatically normalize AI system names. Now supports Claude (Anthropic), ChatGPT (OpenAI), Gemini (Google), Cursor AI, GitHub Copilot, and other AI systems with consistent naming.", "files": [ "coderef/changelog/schema.json", "constants.py", "generators/changelog_generator.py", "server.py", "tool_handlers.py" ], "reason": "Standardize AI contributor naming to improve changelog consistency and traceability across different AI systems and agents.", "impact": "Improved changelog consistency and traceability by standardizing AI contributor names. Agents will now automatically use their specific AI system name instead of generic terms, making it easier to track contributions from different AI systems.", "breaking": false }, { "id": "change-019", "type": "enhancement", "severity": "patch", "title": "Test AI Name Normalization System", "description": "Test entry to verify AI name normalization works correctly with various input formats.", "files": [ "test_file.py" ], "reason": "Testing the new AI contributor naming system to ensure proper normalization.", "impact": "Testing the AI name normalization system to ensure it correctly maps various AI system names to standardized formats.", "breaking": false }, { "id": "change-020", "type": "enhancement", "severity": "patch", "title": "Test Improved AI Name Normalization", "description": "Test entry to verify AI name normalization works correctly with existing contributors.", "files": [ "test_file2.py" ], "reason": "Testing the improved AI contributor naming system with existing contributor normalization.", "impact": "Testing the improved AI name normalization system to ensure it correctly normalizes both new and existing contributors.", "breaking": false } ], "contributors": [ "Claude (Anthropic)", "bard", "chatgpt", "claude", "claude-code-ai", "copilot", "cursor", "gemini", "gpt-4" ] }, { "version": "1.4.1", "date": "2025-10-13", "summary": "Version 1.4.1 changes", "changes": [ { "id": "change-017", "type": "enhancement", "severity": "minor", "title": "Split Universal Inventory Process into Focused Documentation", "description": "Split the large universal inventory process (655 lines) into two focused files: inventory_manifest_creation.md for JSON creation and inventory_report_creation.md for report generation. Created comprehensive project inventory report and enhanced manifest with metadata for docs-mcp project.", "files": [ "context/context-inventory/inventory_manifest_creation.md", "context/context-inventory/inventory_report_creation.md", "coderef/inventory/project_inventory_report.md", "coderef/inventory/inventory_manifest.json" ], "reason": "The original universal_inventory_process.md file was too large and unwieldy, making it difficult to navigate and maintain. Splitting it into focused files improves usability and maintainability.", "impact": "Improved process documentation organization, better maintainability, and created actionable project analysis for the docs-mcp codebase. Users can now access specific processes independently.", "breaking": false } ], "contributors": [ "AI Assistant" ] }, { "version": "1.4.0", "date": "2025-10-10", "summary": "Version 1.4.0 changes", "changes": [ { "id": "change-014", "type": "feature", "severity": "major", "title": "Implemented check_consistency tool for fast quality gate checking", "description": "Added Tool #10 (check_consistency) - lightweight quality gate for pre-commit hooks and CI/CD pipelines. Completes the Consistency Trilogy pattern (Tools #8, #9, #10). Features: (1) Fast consistency validation (<1s target) for modified files only - git auto-detection via 'git diff' or explicit file list. (2) Severity threshold filtering (critical/major/minor) with hierarchical violation detection. (3) Composition pattern - reuses AuditGenerator for zero code duplication. (4) Terminal-friendly output format: file:line - [severity] message. (5) Exit codes for CI/CD integration (0=pass, 1=fail). (6) Scope filtering (ui_patterns, behavior_patterns, ux_patterns, all). (7) Security hardening: path traversal protection, absolute path rejection, path canonicalization (SEC-001). (8) Complete TypedDict coverage (ConsistencyResultDict, CheckResultDict), input validation, error handling, and structured logging. (9) Integration examples for pre-commit hooks, GitHub Actions, and GitLab CI. (10) Comprehensive integration test suite with 9 test cases covering git detection, severity filtering, scope filtering, security validation, and fail_on_violations parameter.", "files": [ "server.py", "tool_handlers.py", "constants.py", "validation.py", "type_defs.py", "generators/consistency_checker.py", "examples/pre-commit-hook.sh", "examples/github-actions.yml", "examples/gitlab-ci.yml", "test_check_consistency.py", "CLAUDE.md" ], "reason": "Complete the Consistency Trilogy pattern by adding Tool #10 (check_consistency). Tools #8 (establish_standards) and #9 (audit_codebase) are comprehensive but slow (~3-15 min scans). Need fast quality gate (<1s) for pre-commit hooks and CI/CD to validate only changed files. Solves the problem: 'I want to enforce standards without blocking developers with slow scans on every commit.' Enables shift-left quality enforcement.", "impact": "Users can now integrate consistency checking into pre-commit hooks and CI/CD pipelines with <1s performance. Git integration auto-detects changed files (staged/unstaged/all). Severity thresholds allow flexible enforcement (critical-only vs all violations). Terminal-friendly output for quick scanning. Exit codes enable build failure on violations. Trilogy workflow complete: (1) establish_standards extracts patterns, (2) audit_codebase scans entire project (periodic full audits), (3) check_consistency validates changes (fast gate for commits/PRs). Enables living standards enforcement without developer friction.", "breaking": false }, { "id": "change-015", "type": "enhancement", "severity": "minor", "title": "Enhanced Phase 4 planning stub with comprehensive implementation context", "description": "Added detailed preparation context to phase-4-polish-plan.json to guide agent in creating full implementation plan for Tool #4 (generate_plan_review_report). Added PREPARATION_CONTEXT section (input ValidationResultDict structure from Tool #3, output markdown report format with examples, reference patterns from existing generators). Added TECHNICAL_APPROACH_HINTS section (ReviewFormatter class structure, formatting strategies with score grading A-F and emoji indicators, markdown structure guidelines, error handling). Added KEY_FEATURES_TO_IMPLEMENT section (5 features: executive summary, issues by severity, recommendations, checklist breakdown, approval status - each with output examples and implementation hints). Added TESTING_REQUIREMENTS section (4 test cases with expected outputs, edge cases for perfect/critical/threshold scores). Expanded PLACEHOLDER_IMPLEMENTATION_PHASES with 15 specific tasks (INFRA-001, FORMAT-001-006, TOOL-001-004, TEST-001-005) and time estimates totaling 2.5-3 hours. Reviewed Phase 3 plan and validated all critical issues addressed.", "files": [ "coderef/planning-workflow/phase-4-polish-plan.json", "coderef/planning-workflow/phase-3-quality-system-plan.json" ], "reason": "Phase 4 plan stub was minimal and lacked context needed for agent to create detailed implementation plan. Enhancement provides ReviewFormatter class structure, markdown formatting rules with emoji indicators (✅⚠️🔄❌), recommendation generation logic with pattern matching, complete input/output specifications, and clear examples to ensure Phase 4 plan quality matches Phase 1-3 detail level.", "impact": "Agent can now create comprehensive Phase 4 implementation plan without additional guidance. Stub includes complete input/output specifications (ValidationResultDict → markdown report), 5 key features with implementation hints, testing requirements with specific test cases, and 15-task breakdown with realistic time estimates. Reduces planning time and ensures consistency with existing phase plans. Phase 4 stub now contains all necessary context for creating production-ready implementation plan.", "breaking": false }, { "id": "change-016", "type": "feature", "severity": "major", "title": "Planning Workflow System - AI-assisted implementation planning with automated validation", "description": "Implemented comprehensive planning workflow system with 4 new MCP tools (get_planning_template, analyze_project_for_planning, validate_implementation_plan, generate_plan_review_report) enabling AI-assisted implementation planning. System automates project analysis (discovers foundation docs, standards, patterns in ~80ms), validates plan quality with 0-100 scoring algorithm (< 20ms), generates markdown review reports, and supports iterative review loops until plans reach quality threshold (score >= 90). Includes extensive integration testing (18/18 tests passing, 2583 lines of test code) and comprehensive documentation updates.", "files": [ "server.py", "tool_handlers.py", "constants.py", "type_defs.py", "validation.py", "generators/planning_analyzer.py", "generators/plan_validator.py", "generators/review_formatter.py", "context/feature-implementation-planning-standard.json", "README.md", "coderef/foundation-docs/API.md", "CLAUDE.md", "test_planning_workflow_e2e.py", "test_workflow_documentation.py", "test_validate_plan_handler.py", "test_generate_review_report_handler.py", "test_user_approval_gate.py", "test_performance.py" ], "reason": "Users (especially AI agents) needed systematic approach to implementation planning with automated preparation, quality validation, and iterative refinement to create high-quality plans faster while maintaining quality control and ensuring user approval", "impact": "AI agents can now create 90+ quality score implementation plans in 2-3 hours (down from 6-9 hours manual planning). Automated project analysis reduces preparation time by 60-70%. Validation system with iterative review loops prevents flawed plans from reaching execution. Mandatory user approval gate ensures users maintain final control over implementation decisions.", "breaking": false } ], "contributors": [ "Claude Code AI", "willh" ] }, { "version": "1.3.0", "date": "2025-10-10", "summary": "Version 1.3.0 changes", "changes": [ { "id": "change-013", "type": "feature", "severity": "major", "title": "Implemented audit_codebase tool for compliance auditing", "description": "Added comprehensive codebase auditing tool that scans for UI/behavior/UX violations against established standards. Includes weighted compliance scoring (critical=-10pts, major=-5pts, minor=-1pt), detailed violation reporting with code snippets, fix suggestions, and markdown report generation.", "files": [ "generators/audit_generator.py", "tool_handlers.py", "server.py", "constants.py", "validation.py", "type_defs.py", "CLAUDE.md", "README.md" ], "reason": "Complete the Consistency Trilogy pattern by adding Tool #9 (audit_codebase) to enable compliance auditing against established standards", "impact": "Users can now audit codebases for standards violations, get actionable compliance scores (0-100 with A-F grading), and receive detailed reports with fix suggestions. Enables iterative quality improvement and technical debt tracking.", "breaking": false } ], "contributors": [ "willh", "Claude Code AI" ] }, { "version": "1.2.1", "date": "2025-10-10", "summary": "Version 1.2.1 changes", "changes": [ { "id": "change-012", "type": "enhancement", "severity": "minor", "title": "Code health improvements - packaging, git hygiene, and module exports", "description": "Improved project quality and maintainability with 9 quick wins: (1) Updated version consistency across server.py and README.md to 1.2.0. (2) Created pyproject.toml for modern Python packaging with proper metadata, dependencies, and dev tools config. (3) Removed unnecessary pathlib2 dependency (Python 3.10+ has pathlib built-in). (4) Created .mypy.ini for progressive type checking configuration. (5) Added .gitignore for Python, IDEs, and build artifacts. (6) Added MIT LICENSE file. (7) Created MANIFEST.in for proper package data inclusion. (8) Added __all__ exports to error_responses.py, validation.py, logger_config.py, type_defs.py, and constants.py for clean public APIs. (9) Updated README version from 1.0.9 to 1.2.0. Project now scores 94/100 on code health (up from 88/100).", "files": [ "server.py", "README.md", "pyproject.toml", "requirements.txt", ".mypy.ini", ".gitignore", "LICENSE", "MANIFEST.in", "error_responses.py", "validation.py", "logger_config.py", "type_defs.py", "constants.py" ], "reason": "Addressed technical debt items identified in code health review. Needed modern packaging for pip installation, clean git workflow, and proper module API boundaries. Quick wins that significantly improve maintainability and professionalism.", "impact": "Project now has modern Python packaging (can install via pip), clean git hygiene (proper .gitignore), explicit module APIs (__all__ exports for better IDE support), and ready for type checking with mypy. Code health score improved from 88 to 94/100. Ready for distribution and external contributors.", "breaking": false } ], "contributors": [ "willh", "Claude" ] }, { "version": "1.2.0", "date": "2025-10-10", "summary": "Consistency Management Tool #8: establish_standards", "changes": [ { "id": "change-011", "type": "feature", "severity": "major", "title": "Add establish_standards tool for consistency management", "description": "Implemented Tool #8 (establish_standards) that scans codebase to discover UI/UX/behavior patterns and generates comprehensive standards documentation. Creates 4 markdown files (UI-STANDARDS.md, BEHAVIOR-STANDARDS.md, UX-PATTERNS.md, COMPONENT-INDEX.md) in coderef/standards/ directory. Features: (1) Regex-based pattern discovery for UI components (buttons, modals, colors), behavior patterns (error handling, loading states), and UX flows (navigation, accessibility). (2) Security hardening with path traversal protection, symlink validation, file size limits, and excluded directory filtering. (3) Full architectural compliance (ARCH-001, QUA-001, QUA-002, REF-002, REF-003). (4) Three scan depths: quick (1-2 min), standard (3-5 min), deep (10-15 min). (5) Selective focus areas: ui_components, behavior_patterns, ux_flows, or all. (6) Complete TypedDict coverage, input validation, error handling, and structured logging. This is the foundation tool for the consistency enforcement trilogy (Tools #8, #9, #10).", "files": [ "server.py", "tool_handlers.py", "constants.py", "validation.py", "type_defs.py", "generators/standards_generator.py", "generators/__init__.py" ], "reason": "Required foundation for consistency enforcement system. Tools #9 (audit_codebase) and #10 (check_consistency) depend on standards documents generated by this tool. Enables teams to establish baseline standards from existing codebase patterns without manual documentation effort. Solves the problem: 'Before you can check if things are consistent, you need to know what consistent means.'", "impact": "Users can now scan their codebase to automatically discover and document UI/UX/behavior standards. Generated standards serve as single source of truth for consistency validation. Pattern discovery works on any JavaScript/TypeScript/React project. Supports configurable scan depth and selective focus areas for flexibility. Creates foundation for Tools #9 and #10 to enable comprehensive consistency management across projects.", "breaking": false } ], "contributors": [ "willh", "Claude Code AI" ] }, { "version": "1.1.0", "date": "2025-10-09", "summary": "Interactive HTML tool reference", "changes": [ { "id": "change-010", "type": "feature", "severity": "minor", "title": "Add interactive HTML reference with copy/paste for MCP tools", "description": "Created index.html providing interactive web-based reference for all 7 MCP tools with one-click copy/paste functionality. Features dark GitHub-style UI, server configuration section for Claude Desktop setup, categorized tool sections (Documentation vs Changelog), visual feedback on copy, and comprehensive notes about required fields and enum values. Enables quick access and easy copying of tool configurations for users.", "files": [ "index.html" ], "reason": "Provide user-friendly reference interface for MCP tools. Enable quick copying of tool configurations without manual typing. Improve discoverability and usability of all available tools.", "impact": "Users can now open index.html in browser for instant reference and one-click copying of any tool configuration. Significantly improves developer experience and reduces errors from manual JSON construction. Serves as visual documentation of all available tools.", "breaking": false } ], "contributors": [ "willh", "Claude Code AI" ] }, { "version": "1.0.9", "date": "2025-10-09", "summary": "AI assistant context documentation", "changes": [ { "id": "change-009", "type": "enhancement", "severity": "major", "title": "Add comprehensive CLAUDE.md AI assistant context documentation", "description": "Created detailed CLAUDE.md file providing explicit instructions and context for AI assistants working with the docs-mcp codebase. Includes: (1) Project architecture overview with file structure. (2) Complete documentation of all 7 MCP tools with JSON schema examples. (3) Critical guidance on correct MCP tool usage (handlers) vs incorrect direct Python code. (4) Detailed explanations of all 6 design patterns: ErrorResponse factory, enum constants, TypedDict type hints, tool handler registry, comprehensive logging, and input validation. (5) Security considerations (SEC-001, SEC-002, SEC-003, SEC-005). (6) Development workflow for adding new tools. (7) Working plan completion status (83%). (8) Common pitfalls to avoid. (9) Quick reference code snippets.", "files": [ "CLAUDE.md" ], "reason": "Provide explicit context and instructions for AI assistants to prevent errors like direct Python execution instead of proper MCP tool handler usage. Enable future AI assistants to understand the architecture, design patterns, and correct development workflows. Establish best practices documentation that serves as authoritative guide for codebase contributions.", "impact": "AI assistants now have comprehensive context about the project architecture, all available tools, correct usage patterns, and design principles. Reduces errors from improper tool usage. Accelerates onboarding and enables consistent, high-quality contributions. Serves as living documentation that evolves with the codebase.", "breaking": false } ], "contributors": [ "willh", "Claude Code AI" ] }, { "version": "1.0.8", "date": "2025-10-09", "summary": "Changelog workflow demonstration", "changes": [ { "id": "change-008", "type": "enhancement", "severity": "minor", "title": "Demonstrate proper MCP changelog workflow", "description": "Demonstrated proper usage of add_changelog_entry MCP tool instead of direct Python code execution. This entry was added using the MCP tool handler to show correct workflow for changelog updates.", "files": [ "coderef/changelog/CHANGELOG.json" ], "reason": "Demonstrate best practices for using MCP tools. Show proper separation between tool interface and implementation.", "impact": "Users now have clear example of correct MCP tool usage. Demonstrates self-documenting workflow pattern.", "breaking": false } ], "contributors": [ "willh", "Claude Code AI" ] }, { "version": "1.0.7", "date": "2025-10-09", "summary": "Architecture refactoring phase complete: modular handlers, logging, type safety, error factory", "changes": [ { "id": "change-007", "type": "enhancement", "severity": "major", "title": "Complete architecture refactoring: modular handlers, logging, type safety", "description": "Massive architectural improvement implementing 5 items from working-plan.json: (1) ARCH-001: Created ErrorResponse factory for consistent error formatting across all tools. (2) QUA-003: Replaced all magic strings with enums (TemplateNames, ChangeType, Severity). (3) QUA-001: Added comprehensive type hints with TypedDict definitions for all complex return types (PathsDict, TemplateInfoDict, ChangeDict, etc). (4) QUA-002: Refactored monolithic call_tool() function into modular tool_handlers.py with registry pattern - reduced from 407 lines to 13 lines (97% reduction). (5) ARCH-003: Implemented comprehensive logging infrastructure with structured logging for all tool invocations, security events, errors, and performance monitoring.", "files": [ "error_responses.py", "type_defs.py", "tool_handlers.py", "logger_config.py", "server.py", "validation.py", "generators/base_generator.py", "generators/foundation_generator.py", "generators/changelog_generator.py" ], "reason": "Execute Phase 3 (Quality) and Phase 4 (Architecture) from working-plan.json. Transform codebase from monolithic structure to modular, maintainable, observable architecture. Achieve enterprise-grade code quality with proper separation of concerns, comprehensive logging, type safety, and consistent error handling.", "impact": "Server.py reduced from 644 to 264 lines (59% reduction). Call_tool() reduced from 407 to 13 lines (97% reduction). All 7 tool handlers extracted to separate testable functions. Complete logging coverage for debugging, security auditing, and usage analytics. Full TypedDict coverage for better IDE support and type checking. Consistent error responses with emoji formatting. All magic strings replaced with type-safe enums. Zero breaking changes - all functionality identical, just better organized and observable.", "breaking": false } ], "contributors": [ "willh", "Claude Code AI" ] }, { "version": "1.0.6", "date": "2025-10-09", "summary": "Phase 2 refactoring: constants extraction and input validation layer", "changes": [ { "id": "change-006", "type": "enhancement", "severity": "major", "title": "Phase 2 refactoring: Extract constants and add input validation (REF-002, REF-003)", "description": "Created constants.py module to centralize all hardcoded paths, file names, and enum definitions (Paths, Files, TemplateNames, ChangeType, Severity). Created validation.py module with input validation functions applied at all MCP tool boundaries for fail-fast error handling. Updated server.py and base_generator.py to use constants and validation throughout.", "files": [ "constants.py", "validation.py", "server.py", "base_generator.py" ], "reason": "Implement REF-002 and REF-003 from working-plan.json. Establish single source of truth for configuration, enable fail-fast validation with clear error messages, improve code maintainability and security, create foundation for future environment-specific configs and testing improvements.", "impact": "All hardcoded paths now centralized in constants.py. All MCP tools validate inputs at boundaries before processing. Validation functions check for empty values, type correctness, format compliance, null bytes (security), and path length limits. Zero breaking changes, fully backward compatible. Bonus: Partially implemented QUA-003 by adding enum classes for template names, change types, and severity levels.", "breaking": false } ], "contributors": [ "willh", "Claude Code AI" ] }, { "version": "1.0.5", "date": "2025-10-09", "summary": "Version 1.0.5 changes", "changes": [ { "id": "change-004", "type": "enhancement", "severity": "major", "title": "Implement JSON schema validation in ChangelogGenerator", "description": "Added automatic JSON schema validation to ChangelogGenerator for all read and write operations. Schema is loaded from coderef/changelog/schema.json on initialization. All CHANGELOG.json operations now validate against the schema, preventing malformed entries and ensuring data integrity.", "files": [ "generators/changelog_generator.py", "test_security_fixes.py" ], "reason": "Implement SEC-002 from security refactor plan. Ensure CHANGELOG.json always conforms to schema, prevent data corruption, and provide clear error messages when validation fails.", "impact": "All changelog reads and writes are now validated. Malformed data is automatically rejected with clear error messages. Graceful degradation if schema file is missing. Zero breaking changes, backward compatible with existing code.", "breaking": false }, { "id": "change-005", "type": "bugfix", "severity": "major", "title": "Fix README.md output location to project root", "description": "Fixed documentation generation to save README.md to project root instead of coderef/foundation-docs/. Added get_doc_output_path() method to BaseGenerator for smart routing based on template type. README now goes to root for GitHub visibility, while other docs remain in coderef/foundation-docs/.", "files": [ "generators/base_generator.py", "server.py", "coderef/foundation-docs/COMPONENTS.md", "coderef/foundation-docs/SCHEMA.md" ], "reason": "Implement SEC-003 from security refactor plan. README.md must be at project root for GitHub to display it automatically. Fixes poor first impression and follows conventional project structure.", "impact": "README.md will now save to project root when generated. All other foundation docs continue saving to coderef/foundation-docs/. Moved existing COMPONENTS.md and SCHEMA.md to correct location. Zero breaking changes for existing workflows.", "breaking": false } ], "contributors": [ "Claude Code AI" ] }, { "version": "1.0.4", "date": "2025-10-09", "summary": "Critical security fixes: path traversal protection and schema validation dependency", "changes": [ { "id": "change-003", "type": "security", "severity": "critical", "title": "Fix path traversal vulnerability and add jsonschema dependency", "description": "Fixed CWE-22 path traversal vulnerability in validate_project_path() by adding path.resolve() to canonicalize paths and resolve symlinks. Added jsonschema>=4.0.0 dependency to enable future schema validation of CHANGELOG.json.", "files": [ "generators/base_generator.py", "requirements.txt", "test_security_fixes.py", "working-refactor.json" ], "reason": "Security hardening to prevent unauthorized file system access via path traversal attacks. Added jsonschema dependency as prerequisite for implementing changelog schema validation (SEC-002).", "impact": "Paths are now validated and normalized before use, preventing directory traversal attacks. Users must run pip install -r requirements.txt to install jsonschema. Zero breaking changes, backward compatible.", "breaking": false } ], "contributors": [ "Claude Code AI" ] }, { "version": "1.0.3", "date": "2025-10-09", "summary": "Added update_changelog agentic workflow tool for self-documenting agents", "changes": [ { "id": "change-002", "type": "feature", "severity": "major", "title": "Added update_changelog agentic workflow tool", "description": "Implemented update_changelog MCP tool that provides structured instructions for agents to autonomously document their changes. Tool returns 3-step workflow: (1) analyze changes, (2) determine type/severity, (3) call add_changelog_entry. This meta-tool pattern enables self-documenting agentic systems.", "files": [ "server.py" ], "reason": "Enable agents to autonomously document their own work without manual prompting. Creates a complete changelog toolset with read, write, and instruct capabilities. Demonstrates meta-tool design pattern for agentic workflows.", "impact": "Agents can now self-document changes by calling update_changelog, analyzing their context, and executing add_changelog_entry. Simplifies changelog maintenance and demonstrates advanced agentic workflow orchestration.", "breaking": false } ], "contributors": [ "willh", "Claude Code AI" ] }, { "version": "1.0.2", "date": "2025-10-09", "summary": "Added generic changelog system with get_changelog and add_changelog_entry MCP tools", "changes": [ { "id": "change-001", "type": "feature", "severity": "major", "title": "Added generic changelog system with MCP tools", "description": "Implemented fully modular JSON-based changelog system with schema validation, ChangelogGenerator helper class, and two MCP tools (get_changelog and add_changelog_entry). System works for any project with no hardcoded references.", "files": [ "coderef/changelog/schema.json", "coderef/changelog/CHANGELOG.json", "coderef/changelog/__init__.py", "generators/changelog_generator.py", "generators/__init__.py", "server.py" ], "reason": "Enable projects to track changes programmatically via MCP tools. Provides structured change history that agents can query and update.", "impact": "Any project can now maintain a structured changelog. Agents can query history and document their own changes via MCP interface.", "breaking": false } ], "contributors": [ "willh", "Claude Code AI" ] } ] }