|
| 1 | +"""Project session management for Basic Memory MCP server. |
| 2 | +
|
| 3 | +Provides simple in-memory project context for MCP tools, allowing users to switch |
| 4 | +between projects during a conversation without restarting the server. |
| 5 | +
|
| 6 | +Session Persistence Flow: |
| 7 | + 1. Pre-tool: Middleware loads self.sessions[session_id] → sets context state |
| 8 | + 2. Tool execution: Uses context.get_state("active_project") |
| 9 | + 3. Project switching: Tool calls set_active_project() → updates context state |
| 10 | + 4. Post-tool: Middleware detects context change → saves to self.sessions[session_id] |
| 11 | +""" |
| 12 | + |
| 13 | +from typing import Optional |
| 14 | +from httpx import AsyncClient |
| 15 | +from loguru import logger |
| 16 | + |
| 17 | +from fastmcp import Context |
| 18 | + |
| 19 | +from basic_memory.mcp.tools.utils import call_get |
| 20 | +from basic_memory.schemas.project_info import ProjectItem |
| 21 | +from basic_memory.utils import generate_permalink |
| 22 | + |
| 23 | + |
| 24 | +async def set_active_project(client: AsyncClient, *, context: Context | None, project: ProjectItem) -> None: |
| 25 | + """Set the active project context. |
| 26 | +
|
| 27 | + Args: |
| 28 | + client (AsyncClient): The client to use for making requests to fastapi. |
| 29 | + project_name: The project to switch to |
| 30 | + context: Optional FastMCP context containing project session state |
| 31 | + """ |
| 32 | + active_project = await get_active_project(client, context= context) |
| 33 | + if active_project.name != project.name: |
| 34 | + previous_project = active_project |
| 35 | + # set project in the context |
| 36 | + if context: |
| 37 | + context.set_state("active_project", project) |
| 38 | + await context.info(f"Context {context.session_id} Switched active project: {previous_project} -> {project.name}") |
| 39 | + logger.info(f"Switched active project: {previous_project} -> {project.name}") |
| 40 | + else: |
| 41 | + logger.debug(f"No change for active project: {active_project}") |
| 42 | + |
| 43 | + |
| 44 | +async def get_active_project(client: AsyncClient, *, context: Context | None, project_override: Optional[str] = None) -> ProjectItem: |
| 45 | + """ |
| 46 | + Get the active project for a tool call. |
| 47 | + If no context is provided, the active project is returned from the default project |
| 48 | +
|
| 49 | + Args: |
| 50 | + client (AsyncClient): The client to use for making requests to fastapi. |
| 51 | + project_override: Optional explicit project name from tool parameter |
| 52 | + context: Optional FastMCP context containing project session state |
| 53 | +
|
| 54 | + Returns: |
| 55 | + The project to use for the tool call |
| 56 | + """ |
| 57 | + |
| 58 | + # Try to get active project from context first |
| 59 | + if context: |
| 60 | + active_project = context.get_state("active_project") |
| 61 | + logger.debug(f"Context {context.session_id} found active project: {active_project}") |
| 62 | + else: |
| 63 | + response = await call_get( |
| 64 | + client, |
| 65 | + f"/projects/default", |
| 66 | + ) |
| 67 | + active_project = ProjectItem.model_validate(response.json()) |
| 68 | + logger.debug(f"No context provided. Using default project: {active_project}") |
| 69 | + |
| 70 | + # Handle project override |
| 71 | + if project_override: |
| 72 | + logger.debug(f"overriding active project: {project_override}") |
| 73 | + permalink = generate_permalink(project_override) |
| 74 | + response = await call_get( |
| 75 | + client, |
| 76 | + f"/{permalink}/item", |
| 77 | + ) |
| 78 | + active_project = ProjectItem.model_validate(response.json()) |
| 79 | + |
| 80 | + return active_project |
| 81 | + |
| 82 | + |
| 83 | +def add_project_metadata(result: str, project_name: str) -> str: |
| 84 | + """Add project context as metadata footer for LLM awareness. |
| 85 | +
|
| 86 | + Args: |
| 87 | + result: The tool result string |
| 88 | + project_name: The project name that was used |
| 89 | +
|
| 90 | + Returns: |
| 91 | + Result with project metadata footer |
| 92 | + """ |
| 93 | + return f"{result}\n\n<!-- Project: {project_name} -->" # pragma: no cover |
0 commit comments