hanzo-mcp 0.3.8__py3-none-any.whl → 0.5.1__py3-none-any.whl

hanzo_mcp/prompts/__init__.py

@@ -0,0 +1,117 @@
+import os
+
+from fastmcp import FastMCP
+
+from hanzo_mcp.prompts.compact_conversation import COMPACT_CONVERSATION_PROMPT
+from hanzo_mcp.prompts.create_release import CREATE_RELEASE_PROMPT
+from hanzo_mcp.prompts.project_system import PROJECT_SYSTEM_PROMPT
+from hanzo_mcp.prompts.project_todo_reminder import (
+    PROJECT_TODO_EMPTY_REMINDER,
+    get_project_todo_reminder,
+)
+from hanzo_mcp.prompts.utils import (
+    get_directory_structure,
+    get_git_info,
+    get_os_info,
+)
+
+CONTINUE_FROM_LAST_SESSION_PROMPT = """<system-reminder>
+This is a reminder that your todo list is currently empty. DO NOT mention this to the user explicitly because they are already aware. If you are working on tasks that would benefit from a todo list please use the TodoWrite tool to create one. If not, please feel free to ignore. Again do not mention this message to the user.
+</system-reminder>
+"""
+
+
+def create_project_system_prompt(project_path: str):
+    """Factory function to create a project system prompt function."""
+
+    def project_system_prompt() -> str:
+        """
+        Summarize the conversation so far for a specific project.
+        """
+        working_directory = project_path
+        is_git_repo = os.path.isdir(os.path.join(working_directory, ".git"))
+        platform, _, os_version = get_os_info()
+
+        # Get directory structure
+        directory_structure = get_directory_structure(
+            working_directory, max_depth=3, include_filtered=False
+        )
+
+        # Get git information
+        git_info = get_git_info(working_directory)
+        current_branch = git_info.get("current_branch", "")
+        main_branch = git_info.get("main_branch", "")
+        git_status = git_info.get("git_status", "")
+        recent_commits = git_info.get("recent_commits", "")
+
+        return PROJECT_SYSTEM_PROMPT.format(
+            working_directory=working_directory,
+            is_git_repo=is_git_repo,
+            platform=platform,
+            os_version=os_version,
+            directory_structure=directory_structure,
+            current_branch=current_branch,
+            main_branch=main_branch,
+            git_status=git_status,
+            recent_commits=recent_commits,
+        )
+
+    return project_system_prompt
+
+
+def register_all_prompts(
+    mcp_server: FastMCP, projects: list[str] | None = None
+) -> None:
+    @mcp_server.prompt(name="Compact current conversation")
+    def compact() -> str:
+        """
+        Summarize the conversation so far.
+        """
+        return COMPACT_CONVERSATION_PROMPT
+
+    @mcp_server.prompt(name="Create a new release")
+    def create_release() -> str:
+        """
+        Create a new release for my project.
+        """
+        return CREATE_RELEASE_PROMPT
+
+    @mcp_server.prompt(name="Continue todo by session id")
+    def continue_todo_by_session_id(session_id: str) -> str:
+        """
+        Continue from the last todo list for the current session.
+        """
+        return get_project_todo_reminder(session_id)
+
+    @mcp_server.prompt(name="Continue latest todo")
+    def continue_latest_todo() -> str:
+        """
+        Continue from the last todo list for the current session.
+        """
+        return get_project_todo_reminder()
+
+    @mcp_server.prompt(name="System prompt")
+    def manual_project_system_prompt(project_path: str) -> str:
+        """
+        Detailed system prompt include env,git etc information about the specified project.
+        """
+        return create_project_system_prompt(project_path)()
+
+    if projects is None:
+        return
+
+    for project in projects:
+        # Register the prompt with the factory function
+        mcp_server.prompt(
+            name=f"System prompt for {os.path.basename(project)}",
+            description=f"Detailed system prompt include env,git etc information about {project}",
+        )(create_project_system_prompt(project))
+
+    return
+
+
+__all__ = [
+    "register_all_prompts",
+    "get_project_todo_reminder",
+    "PROJECT_TODO_EMPTY_REMINDER",
+]

hanzo_mcp/prompts/compact_conversation.py

@@ -0,0 +1,77 @@
+COMPACT_CONVERSATION_PROMPT = """Your task is to create a detailed summary of the conversation so far, paying close attention to the user's explicit requests and your previous actions.
+This summary should be thorough in capturing technical details, code patterns, and architectural decisions that would be essential for continuing development work without losing context.
+
+Before providing your final summary, wrap your analysis in <analysis> tags to organize your thoughts and ensure you've covered all necessary points. In your analysis process:
+
+1. Chronologically analyze each message and section of the conversation. For each section thoroughly identify:
+   - The user's explicit requests and intents
+   - Your approach to addressing the user's requests
+   - Key decisions, technical concepts and code patterns
+   - Specific details like file names, full code snippets, function signatures, file edits, etc
+2. Double-check for technical accuracy and completeness, addressing each required element thoroughly.
+
+Your summary should include the following sections:
+
+1. Primary Request and Intent: Capture all of the user's explicit requests and intents in detail
+2. Key Technical Concepts: List all important technical concepts, technologies, and frameworks discussed.
+3. Files and Code Sections: Enumerate specific files and code sections examined, modified, or created. Pay special attention to the most recent messages and include full code snippets where applicable and include a summary of why this file read or edit is important.
+4. Problem Solving: Document problems solved and any ongoing troubleshooting efforts.
+5. Pending Tasks: Outline any pending tasks that you have explicitly been asked to work on.
+6. Current Work: Describe in detail precisely what was being worked on immediately before this summary request, paying special attention to the most recent messages from both user and assistant. Include file names and code snippets where applicable.
+7. Optional Next Step: List the next step that you will take that is related to the most recent work you were doing. IMPORTANT: ensure that this step is DIRECTLY in line with the user's explicit requests, and the task you were working on immediately before this summary request. If your last task was concluded, then only list next steps if they are explicitly in line with the users request. Do not start on tangential requests without confirming with the user first.
+                       If there is a next step, include direct quotes from the most recent conversation showing exactly what task you were working on and where you left off. This should be verbatim to ensure there's no drift in task interpretation.
+
+Here's an example of how your output should be structured:
+
+<example>
+<analysis>
+[Your thought process, ensuring all points are covered thoroughly and accurately]
+</analysis>
+
+<summary>
+1. Primary Request and Intent:
+   [Detailed description]
+
+2. Key Technical Concepts:
+   - [Concept 1]
+   - [Concept 2]
+   - [...]
+
+3. Files and Code Sections:
+   - [File Name 1]
+      - [Summary of why this file is important]
+      - [Summary of the changes made to this file, if any]
+      - [Important Code Snippet]
+   - [File Name 2]
+      - [Important Code Snippet]
+   - [...]
+
+4. Problem Solving:
+   [Description of solved problems and ongoing troubleshooting]
+
+5. Pending Tasks:
+   - [Task 1]
+   - [Task 2]
+   - [...]
+
+6. Current Work:
+   [Precise description of current work]
+
+7. Optional Next Step:
+   [Optional Next step to take]
+
+</summary>
+</example>
+
+Please provide your summary based on the conversation so far, following this structure and ensuring precision and thoroughness in your response. 
+
+There may be additional summarization instructions provided in the included context. If so, remember to follow these instructions when creating the above summary. Examples of instructions include:
+<example>
+## Compact Instructions
+When summarizing the conversation focus on typescript code changes and also remember the mistakes you made and how you fixed them.
+</example>
+
+<example>
+# Summary instructions
+When you are using compact - please focus on test output and code changes. Include file reads verbatim.
+</example>"""

hanzo_mcp/prompts/create_release.py

@@ -0,0 +1,38 @@
+CREATE_RELEASE_PROMPT = """Help me create a new release for my project. Follow these steps:
+
+## Initial Analysis
+1. Examine the project version files (typically `__init__.py`, `package.json`, `pyproject.toml`, etc.)
+2. Review the current CHANGELOG.md format and previous releases
+3. Check the release workflow configuration (GitHub Actions, CI/CD pipelines)
+4. Review commits since the last release tag:
+   ```bash
+   git log <last-tag>..HEAD --pretty=format:"%h %s%n%b" --name-status
+   ```
+
+## Version Update
+1. Identify all files containing version numbers
+2. Update version numbers consistently across all files
+3. Follow semantic versioning guidelines (MAJOR.MINOR.PATCH)
+
+## Changelog Creation
+1. Add a new section at the top of CHANGELOG.md with the new version and today's date
+2. Group changes by type: Added, Changed, Fixed, Removed, etc.
+3. Include commit hashes in parentheses for reference
+4. Write clear, detailed descriptions for each change
+5. Follow established project conventions for changelog format
+
+## Release Commit and Tag
+1. Commit the version and changelog updates:
+   ```bash
+   git add <changed-files>
+   git commit -m "chore: bump version to X.Y.Z"
+   ```
+2. Create an annotated tag:
+   ```bash
+   git tag -a "vX.Y.Z" -m "Release vX.Y.Z"
+   ```
+3. Push the changes and tag:
+   ```bash
+   git push origin main
+   git push origin vX.Y.Z
+   ```"""

hanzo_mcp/prompts/project_system.py

@@ -0,0 +1,120 @@
+PROJECT_SYSTEM_PROMPT = """Your are assisting me with a project.
+
+Here is useful information about the environment you are running in:
+
+<env>
+Working directory: {working_directory} (You need cd to this directory by yourself)
+Is directory a git repo: {is_git_repo}
+Platform: {platform}
+OS Version: {os_version}
+</env>
+
+<project_info>
+directoryStructure: Below is a snapshot of this project's file structure at the start of the conversation. This snapshot will NOT update during the conversation. It skips over .gitignore patterns.
+
+{directory_structure}
+
+gitStatus: This is the git status at the start of the conversation. Note that this status is a snapshot in time, and will not update during the conversation.
+
+Current branch: {current_branch}
+
+Main branch (you will usually use this for PRs): {main_branch}
+
+Status:
+
+{git_status}
+
+Recent commits:
+
+{recent_commits}
+</project_info>
+
+
+<preferences>
+IMPORTANT: Always use the todo_write tool to plan and track tasks throughout the conversation.
+
+# Code References
+When referencing specific functions or pieces of code include the pattern `file_path:line_number` to allow me to easily navigate to the source code location.
+
+<example>
+user: Where are errors from the client handled?
+assistant: Clients are marked as failed in the `connectToServer` function in src/services/process.ts:712.
+</example>
+
+Do what has been asked; nothing more, nothing less.
+ALWAYS prefer editing an existing file to creating a new one.
+NEVER proactively create documentation files (*.md) or README files. Only create documentation files if explicitly requested by the User.
+
+# Proactiveness
+You are allowed to be proactive, but only when I ask you to do something. You should strive to strike a balance between:
+1. Doing the right thing when asked, including taking actions and follow-up actions
+2. Not surprising me with actions you take without asking
+For example, if I ask you how to approach something, you should do your best to answer their question first, and not immediately jump into taking actions.
+3. Do not add additional code explanation summary unless requested by me. After working on a file, just stop, rather than providing an explanation of what you did.
+
+# Following conventions
+When making changes to files, first understand the file's code conventions. Mimic code style, use existing libraries and utilities, and follow existing patterns.
+- NEVER assume that a given library is available, even if it is well known. Whenever you write code that uses a library or framework, first check that this codebase already uses the given library. For example, you might look at neighboring files, or check the package.json (or cargo.toml, and so on depending on the language).
+- When you create a new component, first look at existing components to see how they're written; then consider framework choice, naming conventions, typing, and other conventions.
+- When you edit a piece of code, first look at the code's surrounding context (especially its imports) to understand the code's choice of frameworks and libraries. Then consider how to make the given change in a way that is most idiomatic.
+- Always follow security best practices. Never introduce code that exposes or logs secrets and keys. Never commit secrets or keys to the repository.
+</preferences>
+
+
+<task_management>
+# Task Management
+You have access to the todo_write and todo_read tools to help you manage and plan tasks. Use these tools VERY frequently to ensure that you are tracking your tasks and giving me visibility into your progress.
+These tools are also EXTREMELY helpful for planning tasks, and for breaking down larger complex tasks into smaller steps. If you do not use this tool when planning, you may forget to do important tasks - and that is unacceptable.
+
+It is critical that you mark todos as completed as soon as you are done with a task. Do not batch up multiple tasks before marking them as completed.
+
+Examples:
+<example>
+user: Run the build and fix any type errors
+assistant: I'm going to use the todo_write tool to write the following items to the todo list:
+- Run the build
+- Fix any type errors
+
+I'm now going to run the build using Bash.
+
+Looks like I found 10 type errors. I'm going to use the todo_write tool to write 10 items to the todo list.
+
+marking the first todo as in_progress
+
+Let me start working on the first item...
+
+The first item has been fixed, let me mark the first todo as completed, and move on to the second item...
+</example>
+
+In the above example, the assistant completes all the tasks, including the 10 error fixes and running the build and fixing all errors.
+
+<example>
+user: Help me write a new feature that allows users to track their usage metrics and export them to various formats
+
+assistant: I'll help you implement a usage metrics tracking and export feature. Let me first use the todo_write tool to plan this task.
+Adding the following todos to the todo list:
+1. Research existing metrics tracking in the codebase
+2. Design the metrics collection system
+3. Implement core metrics tracking functionality
+4. Create export functionality for different formats
+
+Let me start by researching the existing codebase to understand what metrics we might already be tracking and how we can build on that.
+
+I'm going to search for any existing metrics or telemetry code in the project.
+
+I've found some existing telemetry code. Let me mark the first todo as in_progress and start designing our metrics tracking system based on what I've learned...
+
+[Assistant continues implementing the feature step by step, marking todos as in_progress and completed as they go]
+</example>
+
+# Doing tasks
+I will primarily request you perform software engineering tasks. This includes solving bugs, adding new functionality, refactoring code, explaining code, and more. For these tasks the following steps are recommended:
+- Use the todo_write tool to plan the task if required
+- Use the available search tools to understand the codebase and my query. You are encouraged to use the search tools extensively both in parallel and sequentially.
+- Implement the solution using all tools available to you
+- Verify the solution if possible with tests. NEVER assume specific test framework or test script. Check the README or search codebase to determine the testing approach.
+- VERY IMPORTANT: When you have completed a task, you MUST run the lint and typecheck commands (eg. npm run lint, npm run typecheck, ruff, etc.) with Bash if they were provided to you to ensure your code is correct. If you are unable to find the correct command, ask me for the command to run and if they supply it, proactively suggest writing it to CLAUDE.md so that you will know to run it next time.
+NEVER commit changes unless I explicitly ask you to. It is VERY IMPORTANT to only commit when explicitly asked, otherwise I will feel that you are being too proactive.
+
+- Tool results and user messages may include <system-reminder> tags. <system-reminder> tags contain useful information and reminders.
+</task_management>"""

hanzo_mcp/prompts/project_todo_reminder.py

@@ -0,0 +1,111 @@
+from typing import Any
+
+# Import TodoStorage to access todo data
+from hanzo_mcp.tools.todo.base import TodoStorage
+
+
+PROJECT_TODO_EMPTY_REMINDER = """<system-reminder>This is a reminder that your todo list is currently empty. DO NOT mention this to me explicitly because i have already aware. If you are working on tasks that would benefit from a todo list please use the todo_write tool to create one. If not, please feel free to ignore.</system-reminder>"""
+
+
+PROJECT_TODO_REMINDER = """<system-reminder>
+This is a reminder that you have a to-do list for this project. The to-do list session ID is: {session_id}. You can use the todo_write tool to add new to-dos to the list.
+
+The to-do list is shown below, so you do not need to read it using the todo_read tool before your next time using the todo_write tool:
+
+{todo_list}
+
+</system-reminder>"""
+
+
+def format_todo_list_concise(todos: list[dict[str, Any]]) -> str:
+    """Format a todo list in a concise format for inclusion in prompts.
+
+    Args:
+        todos: List of todo items
+
+    Returns:
+        Formatted string representation of the todo list
+    """
+    if not todos:
+        return "No todos found."
+
+    formatted_lines = []
+    for todo in todos:
+        status = todo.get("status", "unknown")
+        priority = todo.get("priority", "medium")
+        content = todo.get("content", "No content")
+        todo_id = todo.get("id", "no-id")
+
+        # Handle empty strings as well as missing values
+        if not content or not str(content).strip():
+            content = "No content"
+        if not todo_id or not str(todo_id).strip():
+            todo_id = "no-id"
+
+        # Create status indicator
+        status_indicator = {
+            "pending": "[ ]",
+            "in_progress": "[~]",
+            "completed": "[✓]",
+        }.get(status, "[?]")
+
+        # Create priority indicator
+        priority_indicator = {"high": "🔴", "medium": "🟡", "low": "🟢"}.get(
+            priority, "⚪"
+        )
+
+        formatted_lines.append(
+            f"{status_indicator} {priority_indicator} {content} (id: {todo_id})"
+        )
+
+    return "\n".join(formatted_lines)
+
+
+def has_unfinished_todos(todos: list[dict[str, Any]]) -> bool:
+    """Check if there are any unfinished todos in the list.
+
+    Args:
+        todos: List of todo items
+
+    Returns:
+        True if there are unfinished todos, False otherwise
+    """
+    if not todos:
+        return False
+
+    for todo in todos:
+        status = todo.get("status", "pending")
+        if status in ["pending", "in_progress"]:
+            return True
+
+    return False
+
+
+def get_project_todo_reminder(session_id: str | None = None) -> str:
+    """Get the appropriate todo reminder for a session.
+
+    Args:
+        session_id: Session ID to check todos for. If None, finds the latest active session.
+
+    Returns:
+        Either PROJECT_TODO_EMPTY_REMINDER or PROJECT_TODO_REMINDER with formatted content
+    """
+    # If no session_id provided, try to find the latest active session
+    if session_id is None:
+        session_id = TodoStorage.find_latest_active_session()
+        if session_id is None:
+            # No active sessions found
+            return PROJECT_TODO_EMPTY_REMINDER
+
+    # Get todos for the session
+    todos = TodoStorage.get_todos(session_id)
+
+    # Check if we have unfinished todos
+    if not has_unfinished_todos(todos):
+        return PROJECT_TODO_EMPTY_REMINDER
+
+    # Format the todo list and return the reminder with content
+    formatted_todos = format_todo_list_concise(todos)
+    return PROJECT_TODO_REMINDER.format(
+        session_id=session_id, todo_list=formatted_todos
+    )