feat: add a prompt to search on Django docs website

Signed-off-by: Rai Siqueira <rai93siqueira@gmail.com>

Author: raisiqueira

opencode.json

@@ -1,13 +1,16 @@
 {
   "$schema": "https://opencode.ai/config.json",
   "mcp": {
-    "django-mcp": {
+    "local-django-telescope": {
       "type": "local",
-      "command": "uv",
-      "args": ["run", "django-mcp", "--settings", "testproject.settings"],
-      "env": {
-        "PYTHONPATH": "./fixtures/testproject"
-      }
+      "command": [
+        "/Users/rai/Developer/vinta/django-mcp/.venv/bin/django-telescope",
+        "--settings",
+        "testproject.settings"
+      ],
+      "environment": {
+        "PYTHONPATH": "/Users/rai/Developer/vinta/django-mcp/fixtures/testproject"
+      },
     }
   }
 }

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-telescope"
-version = "0.1.2"
+version = "0.1.3"
 description = "A Model Context Protocol (MCP) server for Django applications, inspired by Laravel Boost"
 readme = "README.md"
 authors = [

server.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/raisiqueira/django-telescope",
     "source": "github"
   },
-  "version": "0.1.2",
+  "version": "0.1.3",
   "packages": [
     {
       "registryType": "pypi",

src/django_telescope/server_fastmcp.py

@@ -429,6 +429,43 @@ async def reverse_url(
         return {"error": f"Error reversing URL: {str(e)}"}
 
 
+@mcp.prompt()
+async def search_django_docs(topic: str) -> str:
+    """
+    Generate a prompt to help search for specific topics in Django documentation.
+
+    Args:
+        topic: The Django topic or feature to search for (e.g., "models", "queryset", "migrations", "authentication")
+
+    Returns:
+        A formatted prompt to help the user search Django documentation effectively.
+    """
+    django_version = django.get_version()
+    major_version = ".".join(django_version.split(".")[:2])
+
+    prompt = f"""I need help finding information about "{topic}" in Django documentation.
+
+Current Django version: {django_version}
+
+Please help me by:
+1. Searching the official Django documentation at https://docs.djangoproject.com/en/{major_version}/
+2. Providing relevant links to documentation pages about "{topic}"
+3. Explaining key concepts and best practices
+4. Showing code examples if applicable
+
+Focus on documentation that is relevant to Django {major_version} to ensure compatibility with my project.
+
+Key areas to consider:
+- Core concepts and usage patterns
+- API reference and method signatures
+- Common pitfalls and solutions
+- Related topics that might be helpful
+
+Please provide clear, actionable information with direct links to the official documentation."""
+
+    return prompt
+
+
 def run_server(settings_module: str | None = None, transport: str = "stdio"):
     """
     Run the Django MCP server.

test_prompt.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+"""
+Test the search_django_docs prompt.
+
+Note: FastMCP prompts are designed to be called by MCP clients, not directly in Python.
+This test demonstrates the prompt is properly registered and shows what it would return.
+"""
+import asyncio
+import os
+import sys
+
+# Add fixtures project to path
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "fixtures", "testproject"))
+
+# Set Django settings
+os.environ["DJANGO_SETTINGS_MODULE"] = "testproject.settings"
+
+# Import Django and setup
+import django
+
+django.setup()
+
+# Import the server and inspect the prompt
+from django_telescope.server_fastmcp import mcp
+
+
+async def test_search_django_docs_prompt():
+    """Test that the search_django_docs prompt is registered and callable."""
+    print("Testing search_django_docs prompt registration...\n")
+    print("=" * 80)
+
+    # List all registered prompts
+    prompts = await mcp._list_prompts()
+    print(f"Found {len(prompts)} registered prompt(s):\n")
+
+    for prompt in prompts:
+        print(f"✓ Prompt: {prompt.name}")
+        print(f"  Description: {prompt.description}")
+        print(f"  Arguments: {[arg.name for arg in prompt.arguments]}")
+        print()
+
+    # Check if our prompt is registered
+    prompt_names = [p.name for p in prompts]
+    if "search_django_docs" in prompt_names:
+        print("✓ search_django_docs prompt is registered successfully!")
+        print()
+        print("To use this prompt, connect an MCP client and call:")
+        print('  mcp.get_prompt("search_django_docs", arguments={"topic": "models"})')
+        print()
+        print("=" * 80)
+        print("\nExample usage in MCP Inspector or Claude Desktop:\n")
+        print("1. Configure the MCP server in your client")
+        print("2. Use the prompt with a topic, e.g., 'models', 'queryset', etc.")
+        print("3. The prompt will generate a formatted request to search Django docs")
+        print("=" * 80)
+    else:
+        print("✗ search_django_docs prompt not found!")
+
+    # Demonstrate what the prompt function would return for a sample topic
+    print("\nSample output for topic='models':")
+    print("-" * 80)
+    # Access the underlying function through the prompt
+    from django_telescope.server_fastmcp import search_django_docs
+
+    # Get the underlying function
+    result = await search_django_docs.fn("models")
+    print(result)
+    print("=" * 80)
+
+
+if __name__ == "__main__":
+    asyncio.run(test_search_django_docs_prompt())