Add support for prompts

README.md

@@ -6,13 +6,13 @@ https://github.com/user-attachments/assets/aa779b1c-a443-48d7-b3eb-13f27a4333b3
 
 ## Overview
 
-This extension provides a simplified, trait-based approach to exposing Jupyter functionality through the MCP protocol. It can dynamically load and register tools from various Python packages, making them available to AI assistants and other MCP clients.
+This extension provides a simplified, trait-based approach to exposing Jupyter functionality through the MCP protocol. It can dynamically load and register tools and prompts from various Python packages, making them available to AI assistants and other MCP clients.
 
 ## Key Features
 
 - **Simplified Architecture**: Direct function registration without complex abstractions
-- **Configurable Tool Loading**: Register tools via string specifications (`module:function`)
-- **Automatic Tool Discovery**: Python packages can expose tools via entrypoints
+- **Configurable Tool & Prompt Loading**: Register tools and prompts via string specifications (`module:function`)
+- **Automatic Discovery**: Python packages can expose tools and prompts via entrypoints
 - **Jupyter Integration**: Seamless integration with Jupyter Server extension system
 - **HTTP Transport**: FastMCP-based HTTP server with proper MCP protocol support
 - **Traitlets Configuration**: Full configuration support through Jupyter's traitlets system
@@ -42,15 +42,21 @@ c.MCPExtensionApp.mcp_tools = [
     "os:getcwd",
     "json:dumps",
     "time:time",
-    
-    # Jupyter AI Tools - Notebook operations  
+
+    # Jupyter AI Tools - Notebook operations
     "jupyter_ai_tools.toolkits.notebook:read_notebook",
     "jupyter_ai_tools.toolkits.notebook:edit_cell",
-    
+
     # JupyterLab Commands Toolkit
     "jupyterlab_commands_toolkit.tools:list_all_commands",
     "jupyterlab_commands_toolkit.tools:execute_command",
 ]
+
+# Register prompts for code assistance
+c.MCPExtensionApp.mcp_prompts = [
+    "my_package.prompts:code_review_prompt",
+    "my_package.prompts:documentation_prompt",
+]
 ```
 
 ### 2. Start Jupyter Server
@@ -121,9 +127,12 @@ await server.start_server()
 ```
 
 **Key Methods:**
-- `register_tool(func, name=None, description=None)` - Register a Python function
+- `register_tool(func, name=None, description=None)` - Register a Python function as a tool
 - `register_tools(tools)` - Register multiple functions (list or dict)
 - `list_tools()` - Get list of registered tools
+- `register_prompt(func, name=None, description=None)` - Register a Python function as a prompt
+- `register_prompts(prompts)` - Register multiple prompt functions (list or dict)
+- `list_prompts()` - Get list of registered prompts
 - `start_server(host=None)` - Start the HTTP MCP server
 
 #### MCPExtensionApp (`jupyter_server_mcp.extension.MCPExtensionApp`)
@@ -134,7 +143,8 @@ Jupyter Server extension that manages the MCP server lifecycle:
 - `mcp_name` - Server name (default: "Jupyter MCP Server")
 - `mcp_port` - Server port (default: 3001)
 - `mcp_tools` - List of tools to register (format: "module:function")
-- `use_tool_discovery` - Enable automatic tool discovery via entrypoints (default: True)
+- `mcp_prompts` - List of prompts to register (format: "module:function")
+- `use_tool_discovery` - Enable automatic discovery via entrypoints (default: True)
 
 ### Tool Registration
 
@@ -185,6 +195,95 @@ Tools from entrypoints are discovered automatically when the extension starts. T
 c.MCPExtensionApp.use_tool_discovery = False
 ```
 
+### Prompt Registration
+
+Prompts can be registered in two ways:
+
+#### 1. Manual Configuration
+
+Specify prompts directly in your Jupyter configuration using `module:function` format:
+
+```python
+c.MCPExtensionApp.mcp_prompts = [
+    "my_package.prompts:code_review_prompt",
+    "my_package.prompts:documentation_prompt",
+]
+```
+
+#### 2. Automatic Discovery via Entrypoints
+
+Python packages can expose prompts automatically using the `jupyter_server_mcp.prompts` entrypoint group.
+
+**In your package's `pyproject.toml`:**
+
+```toml
+[project.entry-points."jupyter_server_mcp.prompts"]
+my_package_prompts = "my_package.prompts:PROMPTS"
+```
+
+**In `my_package/prompts.py`:**
+
+```python
+# Option 1: Define as a list
+PROMPTS = [
+    "my_package.prompts:code_review_prompt",
+    "my_package.prompts:documentation_prompt",
+    "my_package.prompts:test_generation_prompt",
+]
+
+# Option 2: Define as a function
+def get_prompts():
+    return [
+        "my_package.prompts:code_review_prompt",
+        "my_package.prompts:documentation_prompt",
+    ]
+
+# Example prompt functions
+def code_review_prompt(file_path: str, focus_area: str = "general") -> str:
+    """Generate a code review prompt for a specific file.
+
+    Args:
+        file_path: Path to the file to review
+        focus_area: Aspect to focus on (e.g., 'security', 'performance', 'general')
+
+    Returns:
+        A formatted prompt for code review
+    """
+    return f"""Please review the code in {file_path} with a focus on {focus_area}.
+
+Provide feedback on:
+- Code quality and best practices
+- Potential bugs or issues
+- Performance considerations
+- Security concerns
+- Documentation and readability
+"""
+
+def documentation_prompt(module_name: str, target_audience: str = "developers") -> str:
+    """Generate a documentation prompt for a module.
+
+    Args:
+        module_name: Name of the module to document
+        target_audience: Who will read this (e.g., 'developers', 'users', 'contributors')
+
+    Returns:
+        A formatted prompt for documentation generation
+    """
+    return f"""Create comprehensive documentation for the {module_name} module.
+
+Target audience: {target_audience}
+
+Include:
+- Overview and purpose
+- Key features and capabilities
+- Usage examples with code
+- API reference
+- Common patterns and best practices
+"""
+```
+
+Prompts from entrypoints are discovered automatically when the extension starts, using the same `use_tool_discovery` setting as tools.
+
 ## Configuration Examples
 
 ### Minimal Setup
@@ -203,36 +302,50 @@ c.MCPExtensionApp.mcp_port = 8080
 c.MCPExtensionApp.mcp_tools = [
     # File system operations (jupyter-ai-tools)
     "jupyter_ai_tools.toolkits.file_system:read",
-    "jupyter_ai_tools.toolkits.file_system:write", 
+    "jupyter_ai_tools.toolkits.file_system:write",
     "jupyter_ai_tools.toolkits.file_system:edit",
     "jupyter_ai_tools.toolkits.file_system:ls",
     "jupyter_ai_tools.toolkits.file_system:glob",
-    
+
     # Notebook operations (jupyter-ai-tools)
     "jupyter_ai_tools.toolkits.notebook:read_notebook",
     "jupyter_ai_tools.toolkits.notebook:edit_cell",
-    "jupyter_ai_tools.toolkits.notebook:add_cell", 
+    "jupyter_ai_tools.toolkits.notebook:add_cell",
     "jupyter_ai_tools.toolkits.notebook:delete_cell",
     "jupyter_ai_tools.toolkits.notebook:create_notebook",
-    
+
     # Git operations (jupyter-ai-tools)
     "jupyter_ai_tools.toolkits.git:git_status",
     "jupyter_ai_tools.toolkits.git:git_add",
     "jupyter_ai_tools.toolkits.git:git_commit",
     "jupyter_ai_tools.toolkits.git:git_push",
-    
+
     # JupyterLab operations (jupyterlab-commands-toolkit)
     "jupyterlab_commands_toolkit.tools:clear_all_outputs_in_notebook",
     "jupyterlab_commands_toolkit.tools:open_document",
     "jupyterlab_commands_toolkit.tools:open_markdown_file_in_preview_mode",
     "jupyterlab_commands_toolkit.tools:show_diff_of_current_notebook",
-    
-    # Utility functions  
+
+    # Utility functions
     "os:getcwd",
     "json:dumps",
     "time:time",
     "platform:system",
 ]
+
+c.MCPExtensionApp.mcp_prompts = [
+    # Code analysis prompts
+    "my_package.prompts:code_review_prompt",
+    "my_package.prompts:refactoring_suggestions_prompt",
+
+    # Documentation prompts
+    "my_package.prompts:documentation_prompt",
+    "my_package.prompts:api_documentation_prompt",
+
+    # Testing prompts
+    "my_package.prompts:test_generation_prompt",
+    "my_package.prompts:test_coverage_analysis_prompt",
+]
 ```
 
 ### Running Tests
@@ -258,17 +371,94 @@ jupyter_server_mcp/
 │   └── extension.py       # Jupyter Server extension
 ├── tests/
 │   ├── test_mcp_server.py # MCPServer tests
-│   └── test_extension.py  # Extension tests  
-├── demo/
-│   ├── jupyter_config.py  # Example configuration
-│   └── *.py              # Debug/diagnostic scripts
+│   └── test_extension.py  # Extension tests
 └── pyproject.toml         # Package configuration
 ```
 
+## Example: Creating a Package with Prompts
+
+Here's how to create a package that exposes prompts via entrypoints:
+
+**my_package/prompts.py:**
+```python
+"""Example prompt functions for code assistance."""
+
+def code_review_prompt(file_path: str, focus_area: str = "general") -> str:
+    """Generate a code review prompt for a specific file.
+
+    Args:
+        file_path: Path to the file to review
+        focus_area: Aspect to focus on (e.g., 'security', 'performance', 'general')
+
+    Returns:
+        A formatted prompt for code review
+    """
+    return f"""Please review the code in {file_path} with a focus on {focus_area}.
+
+Provide feedback on:
+- Code quality and best practices
+- Potential bugs or issues
+- Performance considerations
+- Security concerns
+- Documentation and readability
+"""
+
+def documentation_prompt(module_name: str, target_audience: str = "developers") -> str:
+    """Generate a documentation prompt for a module."""
+    return f"""Create comprehensive documentation for the {module_name} module.
+
+Target audience: {target_audience}
+
+Include:
+- Overview and purpose
+- Key features and capabilities
+- Usage examples with code
+- API reference
+- Common patterns and best practices
+"""
+
+def test_generation_prompt(function_name: str, function_code: str) -> str:
+    """Generate a prompt for creating unit tests."""
+    return f"""Generate comprehensive unit tests for the following function:
+
+Function name: {function_name}
+
+Code:
+```python
+{function_code}
+```
+
+Please create:
+- Test cases for normal operation
+- Edge cases and boundary conditions
+- Error handling tests
+- Mocking examples if needed
+"""
+
+# Define prompts list for entrypoint discovery
+PROMPTS = [
+    "my_package.prompts:code_review_prompt",
+    "my_package.prompts:documentation_prompt",
+    "my_package.prompts:test_generation_prompt",
+]
+```
+
+**pyproject.toml:**
+```toml
+[project]
+name = "my-package"
+version = "0.1.0"
+
+[project.entry-points."jupyter_server_mcp.prompts"]
+my_package_prompts = "my_package.prompts:PROMPTS"
+```
+
+After installing your package, the prompts will be automatically discovered and registered when the Jupyter Server MCP extension starts.
+
 ## Contributing
 
 1. Fork the repository
 2. Create a feature branch
-3. Add tests for new functionality  
+3. Add tests for new functionality
 4. Ensure all tests pass: `pytest tests/`
 5. Submit a pull request