Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/basic_memory/mcp/tools/build_context.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Build context tool for Basic Memory MCP server."""

from typing import Optional
from typing import Optional, Union

from loguru import logger

Expand Down Expand Up @@ -35,7 +35,7 @@
)
async def build_context(
url: MemoryUrl,
depth: Optional[int] = 1,
depth: Optional[Union[int, str]] = 1,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my experience, adding more types to the mcp args will sometimes mess up tools like vscode, but lets give this a shot. It's more "correct". FYI, I prefer Optional[int | str] or even a type alias

type StringOrInt = int | str
depth: Optional[StringOrInt]

Copy link
Copy Markdown
Contributor Author

@jope-bm jope-bm Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can try that. This one was weird. The tests that are in this PR actually don't catch the problem -- they pass even without the code change because the string is converted to an int without problems. But testing with the LLM having it "call build_context tool with depth = '3'" would fail just as it was reported in the bug.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool

timeframe: Optional[TimeFrame] = "7d",
page: int = 1,
page_size: int = 10,
Expand Down Expand Up @@ -80,6 +80,15 @@ async def build_context(
build_context("memory://specs/search", project="work-project")
"""
logger.info(f"Building context from {url}")

# Convert string depth to integer if needed
if isinstance(depth, str):
try:
depth = int(depth)
except ValueError:
from mcp.server.fastmcp.exceptions import ToolError
raise ToolError(f"Invalid depth parameter: '{depth}' is not a valid integer")

# URL is already validated and normalized by MemoryUrl type annotation

# Get the active project first to check project-specific sync status
Expand Down
35 changes: 35 additions & 0 deletions tests/cli/test_cli_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,41 @@ def test_build_context_with_options(cli_env, setup_test_note):
assert found, "Context did not include the test note"


def test_build_context_string_depth_parameter(cli_env, setup_test_note):
"""Test build_context command handles string depth parameter correctly."""
permalink = setup_test_note["permalink"]

# Test valid string depth parameter - Typer should convert it to int
result = runner.invoke(
tool_app,
[
"build-context",
f"memory://{permalink}",
"--depth",
"2", # This is always a string from CLI
],
)
assert result.exit_code == 0

# Result should be JSON containing our test note with correct depth
context_result = json.loads(result.stdout)
assert context_result["metadata"]["depth"] == 2

# Test invalid string depth parameter - should fail with Typer validation error
result = runner.invoke(
tool_app,
[
"build-context",
f"memory://{permalink}",
"--depth",
"invalid",
],
)
assert result.exit_code == 2 # Typer exits with code 2 for parameter validation errors
# Typer should show a usage error for invalid integer
assert "invalid" in result.stderr and "is not a valid" in result.stderr and "integer" in result.stderr


# The get-entity CLI command was removed when tools were refactored
# into separate files with improved error handling

Expand Down
20 changes: 20 additions & 0 deletions tests/mcp/test_tool_build_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,23 @@ async def test_build_context_timeframe_formats(client, test_graph):
for timeframe in invalid_timeframes:
with pytest.raises(ToolError):
await build_context.fn(url=test_url, timeframe=timeframe)


@pytest.mark.asyncio
async def test_build_context_string_depth_parameter(client, test_graph):
"""Test that build_context handles string depth parameter correctly."""
test_url = "memory://test/root"

# Test valid string depth parameter - should either raise ToolError or convert to int
try:
result = await build_context.fn(url=test_url, depth="2")
# If it succeeds, verify the depth was converted to an integer
assert isinstance(result.metadata.depth, int)
assert result.metadata.depth == 2
except ToolError:
# This is also acceptable behavior - type validation should catch it
pass

# Test invalid string depth parameter - should raise ToolError
with pytest.raises(ToolError):
await build_context.fn(url=test_url, depth="invalid")
Loading