haiku.rag/tests/test_mcp.py

import logging
import re
from pathlib import Path
from types import SimpleNamespace

import pytest
from fastmcp.exceptions import ToolError

from haiku.rag.client import HaikuRAG
from haiku.rag.mcp import _covering as _mcp_covering
from haiku.rag.mcp import create_mcp_server
from haiku.rag.store.models import Chunk, Document, SearchResult
from haiku.rag.tools.document import DocumentInfo
from tests.multi_db.helpers import _config, _seed, _seed_expandable


@pytest.fixture(autouse=True)
def mock_embedder(monkeypatch):
    """Monkeypatch the embedder to return deterministic vectors."""
    import random

    from haiku.rag.embeddings import EmbedderWrapper

    async def fake_embed_query(self, text):
        random.seed(hash(text) % (2**32))
        return [random.random() for _ in range(2560)]

    async def fake_embed_documents(self, texts):
        result = []
        for t in texts:
            random.seed(hash(t) % (2**32))
            result.append([random.random() for _ in range(2560)])
        return result

    monkeypatch.setattr(EmbedderWrapper, "embed_query", fake_embed_query)
    monkeypatch.setattr(EmbedderWrapper, "embed_documents", fake_embed_documents)


@pytest.fixture
def multimodal_embedder(monkeypatch):
    """An embedder reporting image support, so the image-query tool registers."""
    from haiku.rag.embeddings import EmbedderWrapper

    class StubMultimodal(EmbedderWrapper):
        supports_images = True

        def __init__(self):
            super().__init__(embedder=None, vector_dim=2560)

    monkeypatch.setattr(
        "haiku.rag.embeddings.get_embedder", lambda *a, **kw: StubMultimodal()
    )


@pytest.fixture
async def mcp_db(temp_db_path):
    """Create a test database with sample documents."""
    async with HaikuRAG(temp_db_path, create=True) as rag:
        await rag.create_document(
            "Artificial intelligence is transforming industries worldwide.",
            title="AI Overview",
            uri="test://ai-overview",
            metadata={"author": "Ada"},
        )
        await rag.create_document(
            "Machine learning is a subset of artificial intelligence.",
            title="ML Basics",
            uri="test://ml-basics",
        )
    return temp_db_path


@pytest.fixture
async def two_dbs(tmp_path):
    """Two configured databases, alpha and beta, one document each."""
    config = _config(tmp_path, ["alpha", "beta"])
    await _seed(config, "alpha", ["alpha document about cats"])
    await _seed(config, "beta", ["beta document about cats"])
    return config


def _covering_all(config):
    from haiku.rag.client.scope import DatabaseScope

    return _mcp_covering(DatabaseScope.resolve(config), config)


async def _get_tool(mcp, name):
    """Get a tool function from an MCP server by name."""
    tool = await mcp.get_tool(name)
    return tool.fn


async def _call(mcp, name, **kwargs):
    """Call a tool over the wire, returning the result whether or not it errored."""
    from fastmcp import Client

    async with Client(mcp) as client:
        return await client.call_tool(name, kwargs, raise_on_error=False)


def _results(tool_result) -> list[dict]:
    """A tool's structured result list, as the client sees it."""
    return tool_result.structured_content["result"]


_HEADER = re.compile(r"^\[[^\]]+\] \[rank \d+ of \d+\]$", re.MULTILINE)


def _rendered(search_result) -> list[str]:
    """The result blocks of a search, split from the text the model reads."""
    text = search_result.content[0].text
    starts = [match.start() for match in _HEADER.finditer(text)]
    return [text[a:b].strip() for a, b in zip(starts, starts[1:] + [len(text)])]


def _line(block: str, name: str) -> str | None:
    """The value of a `Name: value` line in a rendered result, if present."""
    match = re.search(rf"^{re.escape(name)}: (.+)$", block, re.MULTILINE)
    return match.group(1) if match else None


def _png_b64() -> str:
    import base64
    from io import BytesIO

    from PIL import Image as PILImage

    buf = BytesIO()
    PILImage.new("RGB", (4, 4), "red").save(buf, format="PNG")
    return base64.b64encode(buf.getvalue()).decode()


class TestMCPReadTools:
    @pytest.mark.asyncio
    async def test_search_documents(self, mcp_db):
        mcp = create_mcp_server(mcp_db)
        search = await _get_tool(mcp, "search_documents")

        blocks = _rendered(await search(query="artificial intelligence"))
        assert blocks
        assert all("Content:" in block for block in blocks)

    @pytest.mark.asyncio
    async def test_search_documents_with_limit(self, mcp_db):
        mcp = create_mcp_server(mcp_db)
        search = await _get_tool(mcp, "search_documents")

        blocks = _rendered(await search(query="artificial intelligence", limit=1))
        assert len(blocks) == 1

    @pytest.mark.asyncio
    @pytest.mark.filterwarnings("ignore:Found propagated trace context:RuntimeWarning")
    async def test_search_documents_with_filter(self, mcp_db):
        from fastmcp import Client

        async with Client(create_mcp_server(mcp_db)) as client:
            result = await client.call_tool(
                "search_documents",
                {"query": "artificial intelligence", "filter": "title = 'ML Basics'"},
            )

        blocks = _rendered(result)
        assert blocks
        assert all('"ML Basics"' in block for block in blocks)

    @pytest.mark.asyncio
    @pytest.mark.filterwarnings("ignore:Found propagated trace context:RuntimeWarning")
    async def test_search_documents_carries_the_matched_chunks_metadata(self, mcp_db):
        """The chunk's own metadata reaches the text the model reads, over the
        wire, without haiku.rag's structural keys."""
        from fastmcp import Client

        async with HaikuRAG(mcp_db, create=True) as rag:
            doc = await rag.get_document_by_uri("test://ai-overview")
            embedding = (await rag.embedder.embed_documents(["x"]))[0]
            await rag.chunk_repository.create(
                Chunk(
                    document_id=doc.id,
                    content="Artificial intelligence is transforming industries worldwide.",
                    metadata={"fake-metadata-for-testing": "42"},
                    embedding=embedding,
                )
            )
            await rag.store.chunks_table.optimize()

        mcp = create_mcp_server(mcp_db)
        async with Client(mcp) as client:
            result = await client.call_tool(
                "search_documents", {"query": "artificial intelligence"}
            )

        text = result.content[0].text
        assert "fake-metadata-for-testing" in text
        assert "42" in text
        assert "doc_item_refs" not in text
        assert result.structured_content is None

    @pytest.mark.asyncio
    @pytest.mark.filterwarnings("ignore:Found propagated trace context:RuntimeWarning")
    async def test_search_results_come_expanded(self, tmp_path):
        """The passage is the hit in its section, as the in-process agents read
        it, not the chunk that matched."""
        config = _config(tmp_path, ["alpha"])
        sentences = ["Gardens need water.", "Roses need pruning.", "Tulips need sun."]
        await _seed_expandable(config, "alpha", sentences)

        result = await _call(_covering_all(config), "search_documents", query="gardens")

        [hit] = _rendered(result)
        assert all(sentence in hit for sentence in sentences)

    @pytest.mark.asyncio
    async def test_get_document(self, mcp_db):
        mcp = create_mcp_server(mcp_db)
        get_doc = await _get_tool(mcp, "get_document")

        # First get the ID via list
        list_docs = await _get_tool(mcp, "list_documents")
        docs = await list_docs()
        doc_id = docs[0].id

        result = await get_doc(document_id=doc_id)
        assert isinstance(result, Document)
        assert result.content != ""
        assert result.title is not None

    @pytest.mark.asyncio
    async def test_get_document_excludes_docling_fields(self, mcp_db):
        mcp = create_mcp_server(mcp_db)
        get_doc = await _get_tool(mcp, "get_document")

        list_docs = await _get_tool(mcp, "list_documents")
        docs = await list_docs()
        doc_id = docs[0].id

        result = await get_doc(document_id=doc_id)
        serialized = result.model_dump(mode="json")
        assert "docling_document" not in serialized
        assert "docling_version" not in serialized

    @pytest.mark.asyncio
    async def test_list_documents(self, mcp_db):
        mcp = create_mcp_server(mcp_db)
        list_docs = await _get_tool(mcp, "list_documents")

        results = await list_docs()
        assert len(results) == 2
        assert all(isinstance(r, DocumentInfo) for r in results)

    @pytest.mark.asyncio
    async def test_list_documents_with_limit(self, mcp_db):
        mcp = create_mcp_server(mcp_db)
        list_docs = await _get_tool(mcp, "list_documents")

        results = await list_docs(limit=1)
        assert len(results) == 1

    @pytest.mark.asyncio
    async def test_list_documents_with_filter(self, mcp_db):
        mcp = create_mcp_server(mcp_db)
        list_docs = await _get_tool(mcp, "list_documents")

        results = await list_docs(filter="title = 'AI Overview'")
        assert len(results) == 1
        assert results[0].title == "AI Overview"

    @pytest.mark.asyncio
    @pytest.mark.filterwarnings("ignore:Found propagated trace context:RuntimeWarning")
    async def test_list_documents_carries_metadata(self, mcp_db):
        from fastmcp import Client

        async with Client(create_mcp_server(mcp_db)) as client:
            result = await client.call_tool("list_documents", {})

        [overview] = [
            d
            for d in result.structured_content["result"]
            if d["title"] == "AI Overview"
        ]
        assert overview["metadata"] == {"author": "Ada"}

    @pytest.mark.asyncio
    async def test_ask_question_appends_the_citations(self, mcp_db, monkeypatch):
        from haiku.rag.store.models.citation import Citation

        citation = Citation(
            chunk_id="c1",
            document_id="d1",
            content="cited text",
            document_uri="test://ai-overview",
            document_title="AI Overview",
            source="alpha",
        )

        async def fake_ask(self, question, filter=None, images=None, sources=None):
            return ("the answer", [citation])

        monkeypatch.setattr(HaikuRAG, "ask", fake_ask)
        mcp = create_mcp_server(mcp_db)
        ask = await _get_tool(mcp, "ask_question")

        answer = await ask(question="q")
        assert answer.startswith("the answer")
        assert "AI Overview" in answer
        # One database: its name adds nothing.
        assert "alpha" not in answer


@pytest.fixture
async def outlined_db(temp_db_path):
    """A database with one document whose items carry a heading hierarchy.

    Rows are written through the repositories, so no embedder is involved.
    Returns the path and the document id."""
    from haiku.rag.store.models.document import Document as DocumentModel
    from haiku.rag.store.models.document_item import DocumentItem

    def header(pos, level, text):
        return DocumentItem(
            document_id="",
            position=pos,
            self_ref=f"#/texts/{pos}",
            label="section_header",
            text=text,
            page_numbers=[pos // 4 + 1],
            heading_level=level,
        )

    def para(pos):
        return DocumentItem(
            document_id="",
            position=pos,
            self_ref=f"#/texts/{pos}",
            label="paragraph",
            text=f"para{pos}",
            page_numbers=[pos // 4 + 1],
        )

    async with HaikuRAG(temp_db_path, create=True) as rag:
        doc = await rag.document_repository.create(
            DocumentModel(content="x", uri="test://outlined", title="Outlined")
        )
        items = [
            header(0, 1, "Intro"),
            para(1),
            header(2, 2, "Background"),
            para(3),
            header(4, 3, "Prior Work"),
            para(5),
            header(6, 2, "Approach"),
            para(7),
            header(8, 1, "Methods"),
            para(9),
        ]
        for item in items:
            item.document_id = doc.id
        await rag.document_item_repository.create_items(doc.id, items)
    return temp_db_path, doc.id


class TestMCPDocumentNavigation:
    @pytest.mark.asyncio
    async def test_the_outline_nests_headings_by_level(self, outlined_db):
        db, doc_id = outlined_db
        outline = await _get_tool(create_mcp_server(db), "get_document_outline")

        roots = await outline(document_id=doc_id)

        assert [n.title for n in roots] == ["Intro", "Methods"]
        intro = roots[0]
        assert (intro.id, intro.level, intro.page_numbers) == ("#/texts/0", 1, [1])
        assert [c.title for c in intro.children] == ["Background", "Approach"]
        assert [c.title for c in intro.children[0].children] == ["Prior Work"]
        assert intro.children[0].children[0].level == 3
        assert roots[1].children == []

    @pytest.mark.asyncio
    async def test_a_document_without_headings_has_an_empty_outline(self, mcp_db):
        mcp = create_mcp_server(mcp_db)
        [doc] = await (await _get_tool(mcp, "list_documents"))(limit=1)
        outline = await _get_tool(mcp, "get_document_outline")

        assert await outline(document_id=doc.id) == []

    @pytest.mark.asyncio
    async def test_a_section_covers_its_subsections_and_stops_at_its_sibling(
        self, outlined_db
    ):
        db, doc_id = outlined_db
        section = await _get_tool(create_mcp_server(db), "get_document_section")

        background = await section(document_id=doc_id, section_id="#/texts/2")

        assert background.title == "Background"
        assert background.content.split("\n\n") == [
            "Background",
            "para3",
            "Prior Work",
            "para5",
        ]
        assert background.page_numbers == [1]

        intro = await section(document_id=doc_id, section_id="#/texts/0")
        assert intro.content.startswith("Intro")
        assert "para7" in intro.content
        assert "Methods" not in intro.content

    @pytest.mark.asyncio
    async def test_an_unknown_section_or_document_is_an_error(self, outlined_db):
        db, doc_id = outlined_db
        mcp = create_mcp_server(db)
        section = await _get_tool(mcp, "get_document_section")
        outline = await _get_tool(mcp, "get_document_outline")

        with pytest.raises(ToolError, match="#/texts/99"):
            await section(document_id=doc_id, section_id="#/texts/99")
        with pytest.raises(ToolError, match="nonexistent-id"):
            await outline(document_id="nonexistent-id")
        with pytest.raises(ToolError, match="nonexistent-id"):
            await section(document_id="nonexistent-id", section_id="#/texts/0")

    @pytest.mark.asyncio
    @pytest.mark.filterwarnings("ignore:Found propagated trace context:RuntimeWarning")
    async def test_outline_and_section_serialize_over_the_wire(self, outlined_db):
        db, doc_id = outlined_db
        mcp = create_mcp_server(db)

        outline = await _call(mcp, "get_document_outline", document_id=doc_id)
        section = await _call(
            mcp, "get_document_section", document_id=doc_id, section_id="#/texts/8"
        )

        assert not outline.is_error and not section.is_error
        [intro, methods] = outline.structured_content["result"]
        assert set(intro) == {"id", "title", "level", "page_numbers", "children"}
        assert intro["children"][0]["children"][0]["title"] == "Prior Work"
        assert set(section.structured_content) == {
            "id",
            "title",
            "page_numbers",
            "content",
        }
        assert section.structured_content["content"] == "Methods\n\npara9"

    @pytest.mark.asyncio
    async def test_source_routes_to_the_database_holding_the_document(self, two_dbs):
        from haiku.rag.store.models.document_item import DocumentItem

        async with HaikuRAG(config=two_dbs, sources=["beta"]) as beta:
            [doc] = await beta.list_documents()
            await beta.document_item_repository.create_items(
                doc.id,
                [
                    DocumentItem(
                        document_id=doc.id,
                        position=0,
                        self_ref="#/texts/0",
                        label="section_header",
                        text="Only in beta",
                        heading_level=1,
                    )
                ],
            )
        mcp = _covering_all(two_dbs)
        outline = await _get_tool(mcp, "get_document_outline")
        section = await _get_tool(mcp, "get_document_section")

        named = await outline(document_id=doc.id, source="beta")
        found = await outline(document_id=doc.id)
        assert [n.title for n in named] == [n.title for n in found] == ["Only in beta"]
        assert (
            await section(document_id=doc.id, section_id="#/texts/0", source="beta")
        ).title == "Only in beta"
        with pytest.raises(ToolError, match="nope"):
            await outline(document_id=doc.id, source="nope")
        with pytest.raises(ToolError, match=doc.id):
            await outline(document_id=doc.id, source="alpha")


@pytest.mark.filterwarnings("ignore:Found propagated trace context:RuntimeWarning")
class TestMCPSearchResultShape:
    """Text as the in-process agents read it, one image per distinct picture,
    and the results as structured content without picture bytes."""

    @staticmethod
    def _serve(monkeypatch, results):
        async def fake_search(self, *args, **kwargs):
            return results

        monkeypatch.setattr(HaikuRAG, "search", fake_search)

    @pytest.mark.asyncio
    async def test_text_ranks_then_one_image_per_distinct_picture(
        self, mcp_db, monkeypatch
    ):
        from mcp.types import ImageContent, TextContent

        shared = {"#/pictures/0": _png_b64()}
        self._serve(
            monkeypatch,
            [
                SearchResult(
                    content="a",
                    score=0.9,
                    chunk_id="c1",
                    document_id="d1",
                    image_data=shared,
                ),
                SearchResult(
                    content="b",
                    score=0.8,
                    chunk_id="c2",
                    document_id="d1",
                    image_data=shared,
                ),
                SearchResult(
                    content="c",
                    score=0.7,
                    chunk_id="c3",
                    document_id="d2",
                    image_data={"#/pictures/3": _png_b64()},
                ),
            ],
        )

        result = await _call(create_mcp_server(mcp_db), "search_documents", query="q")

        text, *rest = result.content
        assert isinstance(text, TextContent)
        assert "[rank 1 of 3]" in text.text and "[rank 3 of 3]" in text.text
        assert "score" not in text.text
        assert "Document ID: d1" in text.text
        images = [block for block in rest if isinstance(block, ImageContent)]
        labels = [block.text for block in rest if isinstance(block, TextContent)]
        assert len(images) == 2
        assert all(image.mime_type == "image/png" for image in images)
        assert [
            label for label in labels if "[c1]" in label and "#/pictures/0" in label
        ]
        assert [
            label for label in labels if "[c3]" in label and "#/pictures/3" in label
        ]
        assert [block.split("]")[0] for block in _rendered(result)] == [
            "[c1",
            "[c2",
            "[c3",
        ]
        assert result.structured_content is None

    @pytest.mark.asyncio
    async def test_an_undecodable_picture_yields_no_image(self, mcp_db, monkeypatch):
        import base64

        self._serve(
            monkeypatch,
            [
                SearchResult(
                    content="a",
                    score=0.9,
                    chunk_id="c1",
                    document_id="d1",
                    image_data={
                        "#/pictures/0": base64.b64encode(b"not a png").decode()
                    },
                )
            ],
        )

        result = await _call(create_mcp_server(mcp_db), "search_documents", query="q")

        assert len(result.content) == 1
        assert "[rank 1 of 1]" in result.content[0].text

    @pytest.mark.asyncio
    async def test_no_results_says_so(self, mcp_db, monkeypatch):
        self._serve(monkeypatch, [])

        result = await _call(create_mcp_server(mcp_db), "search_documents", query="q")

        assert [block.text for block in result.content] == ["No results found."]
        assert result.structured_content is None

    @pytest.mark.asyncio
    async def test_search_text_alone_drives_the_document_tools(self, two_dbs):
        """Over two databases, every result's `Document ID` and `Collection`
        parsed from the text are working arguments for the outline and
        section tools."""
        import re

        from haiku.rag.store.models.document_item import DocumentItem

        for name in ("alpha", "beta"):
            async with HaikuRAG(config=two_dbs, sources=[name]) as rag:
                [doc] = await rag.list_documents()
                await rag.document_item_repository.create_items(
                    doc.id,
                    [
                        DocumentItem(
                            document_id=doc.id,
                            position=0,
                            self_ref="#/texts/0",
                            label="section_header",
                            text=f"Heading in {name}",
                            heading_level=1,
                        )
                    ],
                )
        mcp = _covering_all(two_dbs)

        search = await _call(mcp, "search_documents", query="cats")
        pairs = re.findall(
            r"Document ID: (\S+)\nCollection: (\S+)", search.content[0].text
        )

        assert len(pairs) == len(_rendered(search)) == 2
        assert {source for _, source in pairs} == {"alpha", "beta"}
        for document_id, source in pairs:
            outline = await _call(
                mcp, "get_document_outline", document_id=document_id, source=source
            )
            [node] = _results(outline)
            section = await _call(
                mcp,
                "get_document_section",
                document_id=document_id,
                section_id=node["id"],
                source=source,
            )
            assert section.structured_content["title"] == f"Heading in {source}"


@pytest.mark.filterwarnings("ignore:Found propagated trace context:RuntimeWarning")
class TestMCPDescribesItself:
    """What a client learns from initialize and list_tools, over the wire."""

    @pytest.mark.asyncio
    async def test_instructions_and_version_are_set(self, mcp_db):
        from importlib import metadata

        from fastmcp import Client

        async with Client(create_mcp_server(mcp_db)) as client:
            instructions = client.instructions
            server_info = client.server_info

        assert instructions
        assert server_info is not None
        assert server_info.version == metadata.version("haiku.rag-slim")

    @pytest.mark.asyncio
    async def test_instructions_name_the_collections_when_covering_several(
        self, two_dbs
    ):
        from fastmcp import Client

        from haiku.rag.client.scope import DatabaseScope

        async with Client(_covering_all(two_dbs)) as client:
            covering_both = client.instructions
        one = DatabaseScope.resolve(two_dbs, database_name="alpha")
        async with Client(_mcp_covering(one, two_dbs)) as client:
            covering_one = client.instructions

        assert "alpha" in covering_both
        assert "beta" in covering_both
        assert "beta" not in covering_one

    @pytest.mark.asyncio
    async def test_instructions_without_agents_drop_only_their_clause(self, mcp_db):
        from fastmcp import Client

        async with Client(create_mcp_server(mcp_db)) as client:
            full = client.instructions.splitlines()
        async with Client(create_mcp_server(mcp_db, agents=False)) as client:
            without = client.instructions.splitlines()

        assert set(without) < set(full)
        assert len(without) == len(full) - 1

    @pytest.mark.asyncio
    async def test_instructions_carry_the_domain_preamble(self, mcp_db):
        from fastmcp import Client

        from haiku.rag.config import get_config

        config = get_config().model_copy(deep=True)
        config.prompts.domain_preamble = "Everything here is about zebras."

        async with Client(create_mcp_server(mcp_db, config=config)) as client:
            with_preamble = client.instructions
        async with Client(create_mcp_server(mcp_db)) as client:
            without = client.instructions

        assert "Everything here is about zebras." in with_preamble
        assert "zebras" not in without

    @pytest.mark.asyncio
    async def test_every_tool_is_annotated_read_only(self, mcp_db, multimodal_embedder):
        from fastmcp import Client

        async with Client(create_mcp_server(mcp_db)) as client:
            tools = await client.list_tools()

        assert len(tools) == 8
        for tool in tools:
            assert tool.annotations is not None, tool.name
            assert tool.annotations.read_only_hint is True, tool.name
            assert tool.annotations.open_world_hint is False, tool.name
            assert tool.annotations.title, tool.name

    @pytest.mark.asyncio
    async def test_every_parameter_is_described(self, mcp_db, multimodal_embedder):
        from fastmcp import Client

        async with Client(create_mcp_server(mcp_db)) as client:
            tools = await client.list_tools()

        undescribed = [
            f"{tool.name}.{name}"
            for tool in tools
            for name, schema in tool.input_schema.get("properties", {}).items()
            if not schema.get("description")
        ]
        assert len(tools) == 8
        assert undescribed == []


class TestMCPToolSet:
    @pytest.mark.asyncio
    async def test_the_server_registers_read_tools_only(self, mcp_db):
        mcp = create_mcp_server(mcp_db)

        assert {t.name for t in await mcp.list_tools()} == {
            "search_documents",
            "get_document",
            "get_document_outline",
            "get_document_section",
            "list_documents",
            "ask_question",
            "analyze",
        }

    @pytest.mark.asyncio
    async def test_without_agents_the_agent_tools_are_not_registered(self, mcp_db):
        mcp = create_mcp_server(mcp_db, agents=False)

        assert {t.name for t in await mcp.list_tools()} == {
            "search_documents",
            "get_document",
            "get_document_outline",
            "get_document_section",
            "list_documents",
        }


class TestMCPCoversTheConfiguredSet:
    @pytest.mark.asyncio
    async def test_results_name_the_database_they_came_from(self, two_dbs):
        mcp = _covering_all(two_dbs)
        search = await _get_tool(mcp, "search_documents")

        blocks = _rendered(await search(query="cats"))

        assert {_line(block, "Collection") for block in blocks} == {"alpha", "beta"}

    @pytest.mark.asyncio
    async def test_sources_narrows_the_search(self, two_dbs):
        mcp = _covering_all(two_dbs)
        search = await _get_tool(mcp, "search_documents")

        blocks = _rendered(await search(query="cats", sources=["beta"]))

        assert blocks
        assert {_line(block, "Collection") for block in blocks} == {"beta"}

    @pytest.mark.asyncio
    @pytest.mark.parametrize(
        "tool_name,kwargs",
        [
            ("search_documents", {"query": "cats", "sources": ["nope"]}),
            (
                "search_documents_by_image",
                {"image_base64": "AAAA", "sources": ["nope"]},
            ),
            ("get_document", {"document_id": "x", "source": "nope"}),
            ("ask_question", {"question": "q", "sources": ["nope"]}),
            ("analyze", {"question": "q", "sources": ["nope"]}),
        ],
    )
    async def test_an_unknown_database_is_an_error_not_an_empty_result(
        self, two_dbs, multimodal_embedder, tool_name, kwargs
    ):
        mcp = _covering_all(two_dbs)
        tool = await _get_tool(mcp, tool_name)

        with pytest.raises(ToolError, match="nope"):
            await tool(**kwargs)

    @pytest.mark.asyncio
    async def test_a_filtered_search_touches_only_the_selected_databases(self, two_dbs):
        """alpha is gone; a filtered search selecting beta must not notice."""
        import shutil

        shutil.rmtree(two_dbs.lancedb.databases["alpha"])
        mcp = _covering_all(two_dbs)
        search = await _get_tool(mcp, "search_documents")

        blocks = _rendered(
            await search(query="cats", filter="uri LIKE '%beta%'", sources=["beta"])
        )
        assert blocks
        assert {_line(block, "Collection") for block in blocks} == {"beta"}
        none = await search(query="cats", filter="uri LIKE '%beta%'", sources=[])
        assert _rendered(none) == []

    @pytest.mark.asyncio
    async def test_the_listing_covers_every_database(self, two_dbs):
        mcp = _covering_all(two_dbs)
        list_docs = await _get_tool(mcp, "list_documents")

        documents = await list_docs()

        assert {d.source for d in documents} == {"alpha", "beta"}

    @pytest.mark.asyncio
    async def test_get_document_reaches_whichever_database_holds_it(self, two_dbs):
        mcp = _covering_all(two_dbs)
        list_docs = await _get_tool(mcp, "list_documents")
        get_doc = await _get_tool(mcp, "get_document")
        [beta] = [d for d in await list_docs() if d.source == "beta"]

        found = await get_doc(document_id=beta.id)
        named = await get_doc(document_id=beta.id, source="beta")

        assert found.id == named.id == beta.id
        assert found.source == named.source == "beta"

    @pytest.mark.asyncio
    async def test_the_public_factory_covers_a_configured_set(self, two_dbs):
        mcp = create_mcp_server(config=two_dbs)
        search = await _get_tool(mcp, "search_documents")

        blocks = _rendered(await search(query="cats"))

        assert {_line(block, "Collection") for block in blocks} == {"alpha", "beta"}

    @pytest.mark.asyncio
    async def test_ask_question_names_each_citations_database(
        self, two_dbs, monkeypatch
    ):
        from haiku.rag.store.models.citation import Citation

        def cited(source):
            return Citation(
                chunk_id="c1",
                document_id="d1",
                content="cited text",
                document_uri="test://cats",
                document_title="Cats",
                source=source,
            )

        async def fake_ask(self, question, filter=None, images=None, sources=None):
            return ("the answer", [cited("alpha"), cited("beta")])

        monkeypatch.setattr(HaikuRAG, "ask", fake_ask)
        mcp = _covering_all(two_dbs)
        ask = await _get_tool(mcp, "ask_question")

        answer = await ask(question="q")

        assert "alpha" in answer
        assert "beta" in answer

    @pytest.mark.asyncio
    @pytest.mark.parametrize(
        "tool_name,client_method,returns",
        [
            ("ask_question", "ask", ("answer", [])),
            ("analyze", "analyze", SimpleNamespace(answer="answer")),
        ],
    )
    async def test_agents_search_the_selected_databases(
        self, two_dbs, monkeypatch, tool_name, client_method, returns
    ):
        seen = {}

        async def fake(self, question, filter=None, images=None, sources=None):
            seen["sources"] = sources
            return returns

        monkeypatch.setattr(HaikuRAG, client_method, fake)
        mcp = _covering_all(two_dbs)
        tool = await _get_tool(mcp, tool_name)

        await tool(question="q", sources=["beta"])

        assert seen["sources"] == ["beta"]


class TestMCPImageQuery:
    """search_documents_by_image is registered only when the embedder is multimodal."""

    @pytest.mark.asyncio
    async def test_image_query_tool_absent_for_text_only_embedder(self, mcp_db):
        """Default text-only embedder must not expose the image-query tool."""
        mcp = create_mcp_server(mcp_db)
        names = {t.name for t in await mcp.list_tools()}
        assert "search_documents_by_image" not in names

    @pytest.mark.asyncio
    async def test_image_query_tool_registered_for_multimodal_embedder(
        self, mcp_db, multimodal_embedder, monkeypatch
    ):
        """When the embedder reports supports_images=True, the tool exists
        and routes the decoded image and the selection through ``client.search``."""
        seen = {}

        async def fake_search(self, query, **kwargs):
            seen.update(query=query, **kwargs)
            return []

        monkeypatch.setattr(HaikuRAG, "search", fake_search)

        mcp = create_mcp_server(mcp_db)
        names = {t.name for t in await mcp.list_tools()}
        assert "search_documents_by_image" in names

        search_by_image = await _get_tool(mcp, "search_documents_by_image")
        import base64

        png = b"\x89PNG\r\n\x1a\n"
        results = await search_by_image(
            image_base64=base64.b64encode(png).decode("ascii"),
            filter="uri LIKE 'x%'",
            sources=[],
        )

        assert _rendered(results) == []
        assert seen["query"] == png
        assert seen["filter"] == "uri LIKE 'x%'"
        assert seen["sources"] == []

    @pytest.mark.asyncio
    async def test_image_query_rejects_characters_outside_the_alphabet(
        self, mcp_db, multimodal_embedder, monkeypatch
    ):
        """A lenient decoder would drop the stray characters and search."""
        searched = False

        async def fake_search(self, query, **kwargs):
            nonlocal searched
            searched = True
            return []

        monkeypatch.setattr(HaikuRAG, "search", fake_search)
        mcp = create_mcp_server(mcp_db)
        search_by_image = await _get_tool(mcp, "search_documents_by_image")

        with pytest.raises(ToolError):
            await search_by_image(image_base64="AAAA!!!!")
        assert not searched


class TestMCPImageInput:
    @pytest.mark.asyncio
    async def test_ask_question_decodes_images(self, mcp_db, monkeypatch):
        from base64 import b64encode

        captured = {}

        async def fake_ask(self, question, filter=None, images=None, sources=None):
            captured["images"] = images
            return ("answer", [])

        monkeypatch.setattr(HaikuRAG, "ask", fake_ask)
        mcp = create_mcp_server(mcp_db)
        ask = await _get_tool(mcp, "ask_question")

        png = b"fake image bytes"
        result = await ask(question="q", images_base64=[b64encode(png).decode()])
        assert result == "answer"
        assert captured["images"] == [png]

    @pytest.mark.asyncio
    async def test_analyze_decodes_images(self, mcp_db, monkeypatch):
        from base64 import b64encode
        from types import SimpleNamespace

        captured = {}

        async def fake_analyze(self, question, filter=None, images=None, sources=None):
            captured["images"] = images
            return SimpleNamespace(answer="answer")

        monkeypatch.setattr(HaikuRAG, "analyze", fake_analyze)
        mcp = create_mcp_server(mcp_db)
        analyze = await _get_tool(mcp, "analyze")

        jpeg = b"fake jpeg bytes"
        result = await analyze(question="q", images_base64=[b64encode(jpeg).decode()])
        assert result == "answer"
        assert captured["images"] == [jpeg]

    @pytest.mark.asyncio
    async def test_ask_question_without_images_passes_none(self, mcp_db, monkeypatch):
        captured = {}

        async def fake_ask(self, question, filter=None, images=None, sources=None):
            captured["images"] = images
            return ("answer", [])

        monkeypatch.setattr(HaikuRAG, "ask", fake_ask)
        mcp = create_mcp_server(mcp_db)
        ask = await _get_tool(mcp, "ask_question")

        result = await ask(question="q")
        assert result == "answer"
        assert captured["images"] is None


@pytest.mark.filterwarnings("ignore:Found propagated trace context:RuntimeWarning")
class TestMCPErrorContract:
    """A failure is an error on the wire, never an empty result. Expected
    failures say what went wrong; anything else is masked and logged on the
    server."""

    @pytest.mark.asyncio
    async def test_an_unknown_document_is_an_error(self, mcp_db):
        result = await _call(
            create_mcp_server(mcp_db), "get_document", document_id="nonexistent-id"
        )

        assert result.is_error
        assert "nonexistent-id" in result.content[0].text

    @pytest.mark.asyncio
    @pytest.mark.parametrize(
        "tool_name,kwargs",
        [("search_documents", {"query": "x"}), ("list_documents", {})],
    )
    async def test_an_invalid_filter_is_an_error_naming_the_filter(
        self, mcp_db, tool_name, kwargs
    ):
        result = await _call(
            create_mcp_server(mcp_db), tool_name, filter="no_such_column = 1", **kwargs
        )

        assert result.is_error
        assert "no_such_column = 1" in result.content[0].text
        assert "created_at" in result.content[0].text
        assert "_rowid" not in result.content[0].text

    @pytest.mark.asyncio
    @pytest.mark.parametrize("filter", [None, "title = 'AI Overview'"])
    async def test_a_value_error_from_the_read_is_not_an_invalid_filter(
        self, mcp_db, monkeypatch, filter
    ):
        """Only the filter check translates ValueError; one raised by the read
        itself, with or without a valid filter, stays masked."""

        async def boom(self, *args, **kw):
            raise ValueError("boom at /secret/path")

        monkeypatch.setattr(HaikuRAG, "search", boom)
        result = await _call(
            create_mcp_server(mcp_db), "search_documents", query="x", filter=filter
        )

        assert result.is_error
        assert "filter" not in result.content[0].text
        assert "/secret/path" not in result.content[0].text

    @pytest.mark.asyncio
    @pytest.mark.parametrize(
        "payload", ["!!! not base64 !!!", "é"], ids=["outside_alphabet", "non_ascii"]
    )
    @pytest.mark.parametrize(
        "tool_name,image_param,many",
        [
            ("search_documents_by_image", "image_base64", False),
            ("ask_question", "images_base64", True),
            ("analyze", "images_base64", True),
        ],
    )
    async def test_invalid_base64_is_an_error(
        self, mcp_db, multimodal_embedder, tool_name, image_param, many, payload
    ):
        kwargs: dict[str, object] = {"question": "q"} if many else {}
        kwargs[image_param] = [payload] if many else payload

        result = await _call(create_mcp_server(mcp_db), tool_name, **kwargs)

        assert result.is_error
        assert "base64" in result.content[0].text

    @pytest.mark.asyncio
    @pytest.mark.parametrize(
        "client_method,tool_name",
        [("ask", "ask_question"), ("analyze", "analyze")],
    )
    async def test_an_agent_failure_names_only_its_type(
        self, mcp_db, monkeypatch, caplog, client_method, tool_name
    ):
        async def boom(self, question, filter=None, images=None, sources=None):
            raise RuntimeError("boom at /secret/path")

        monkeypatch.setattr(HaikuRAG, client_method, boom)
        with caplog.at_level(logging.ERROR, logger="haiku.rag.mcp"):
            result = await _call(create_mcp_server(mcp_db), tool_name, question="q")

        assert result.is_error
        assert "RuntimeError" in result.content[0].text
        assert "/secret/path" not in result.content[0].text
        assert any(
            r.exc_info and "boom at /secret/path" in str(r.exc_info[1])
            for r in caplog.records
        )

    @pytest.mark.asyncio
    @pytest.mark.parametrize(
        "client_method,tool_name,kwargs",
        [
            ("search", "search_documents", {"query": "x"}),
            ("search", "search_documents_by_image", {"image_base64": "AAAA"}),
            ("get_document_by_id", "get_document", {"document_id": "x"}),
            ("list_documents", "list_documents", {}),
        ],
    )
    async def test_an_unexpected_failure_is_masked_and_logged(
        self,
        mcp_db,
        multimodal_embedder,
        monkeypatch,
        caplog,
        client_method,
        tool_name,
        kwargs,
    ):
        async def boom(self, *args, **kw):
            raise RuntimeError("boom at /secret/path")

        monkeypatch.setattr(HaikuRAG, client_method, boom)
        # fastmcp's logger does not propagate, so listen to it directly.
        fastmcp_logger = logging.getLogger("fastmcp")
        fastmcp_logger.addHandler(caplog.handler)
        try:
            result = await _call(create_mcp_server(mcp_db), tool_name, **kwargs)
        finally:
            fastmcp_logger.removeHandler(caplog.handler)

        assert result.is_error
        assert "/secret/path" not in result.content[0].text
        assert any(
            r.exc_info and "boom at /secret/path" in str(r.exc_info[1])
            for r in caplog.records
        )


class TestClaudeCodePlugin:
    """The plugin under claude-plugin/ points at the server this module builds."""

    root = Path(__file__).resolve().parents[1]

    def test_the_manifests_name_the_plugin_and_its_server(self):
        import json

        plugin = json.loads(
            (self.root / "claude-plugin/.claude-plugin/plugin.json").read_text()
        )
        marketplace = json.loads(
            (self.root / ".claude-plugin/marketplace.json").read_text()
        )
        servers = json.loads((self.root / "claude-plugin/.mcp.json").read_text())

        assert plugin["name"] == "haiku-rag"
        assert plugin["description"]
        [entry] = marketplace["plugins"]
        assert entry["name"] == plugin["name"]
        assert entry["source"] == "./claude-plugin"
        assert servers["mcpServers"]["haiku-rag"]["args"] == ["mcp", "--stdio"]

    @pytest.mark.asyncio
    async def test_the_skill_pre_approves_every_tool_the_server_registers(
        self, mcp_db, multimodal_embedder
    ):
        import yaml

        text = (self.root / "claude-plugin/skills/haiku-rag/SKILL.md").read_text()
        _, frontmatter, _ = text.split("---", 2)
        skill = yaml.safe_load(frontmatter)
        prefix = "mcp__plugin_haiku-rag_haiku-rag__"

        assert skill["name"] == "haiku-rag"
        assert skill["description"]
        assert all(tool.startswith(prefix) for tool in skill["allowed-tools"])
        approved = {tool.removeprefix(prefix) for tool in skill["allowed-tools"]}
        registered = {t.name for t in await create_mcp_server(mcp_db).list_tools()}
        assert approved == registered


class TestMCPClientLifetime:
    @pytest.mark.asyncio
    async def test_tool_calls_share_one_database_open(self, mcp_db, monkeypatch):
        from haiku.rag.store.engine import Store

        opens = 0
        initialize = Store._initialize

        async def counted(self):
            nonlocal opens
            opens += 1
            return await initialize(self)

        monkeypatch.setattr(Store, "_initialize", counted)

        mcp = create_mcp_server(mcp_db)
        search = await _get_tool(mcp, "search_documents")
        list_docs = await _get_tool(mcp, "list_documents")
        await search(query="artificial intelligence")
        await list_docs()
        await search(query="machine learning")

        assert opens == 1

    @pytest.mark.asyncio
    async def test_concurrent_reads_share_one_open(self, mcp_db, monkeypatch):
        import asyncio

        from haiku.rag.store.engine import Store

        opens = 0
        initialize = Store._initialize

        async def counted(self):
            nonlocal opens
            opens += 1
            return await initialize(self)

        monkeypatch.setattr(Store, "_initialize", counted)

        mcp = create_mcp_server(mcp_db)
        list_docs = await _get_tool(mcp, "list_documents")

        results = await asyncio.gather(*(list_docs() for _ in range(5)))

        assert opens == 1
        assert all(len(r) == 2 for r in results)

    @pytest.mark.asyncio
    async def test_lifespan_opens_and_closes_once(self, mcp_db, monkeypatch):
        from haiku.rag.store.engine import Store

        opens = 0
        initialize = Store._initialize

        async def counted(self):
            nonlocal opens
            opens += 1
            return await initialize(self)

        monkeypatch.setattr(Store, "_initialize", counted)

        mcp = create_mcp_server(mcp_db)
        # _lifespan_manager is what every transport enters; the public
        # lifespan() combines provider lifespans only.
        async with mcp._lifespan_manager():
            assert opens == 1, "startup should open the database, not the first call"
            search = await _get_tool(mcp, "search_documents")
            await search(query="artificial intelligence")
            assert opens == 1

        assert opens == 1

    @pytest.mark.asyncio
    async def test_the_scope_decides_the_database_and_names_its_results(
        self, mcp_db, tmp_path
    ):
        """The scope is the selection: the server reads the one database it
        names, and results carry that name."""
        from haiku.rag.client.scope import DatabaseScope
        from haiku.rag.config.models import AppConfig, LanceDBConfig

        other = tmp_path / "beta.lancedb"
        async with HaikuRAG(other, create=True) as rag:
            await rag.create_document(
                "Zebras graze on the savannah.", title="Zebras", uri="test://zebras"
            )

        config = AppConfig(
            lancedb=LanceDBConfig(databases={"alpha": str(mcp_db), "beta": str(other)})
        )
        scope = DatabaseScope.resolve(config, database_name="alpha")

        mcp = _mcp_covering(scope, config)
        async with mcp._lifespan_manager():
            search = await _get_tool(mcp, "search_documents")
            blocks = _rendered(await search(query="artificial intelligence"))
            listing = await _get_tool(mcp, "list_documents")
            documents = await listing()

        assert blocks
        assert {_line(block, "Collection") for block in blocks} == {None}
        titles = {d.title for d in documents}
        assert "AI Overview" in titles
        assert "Zebras" not in titles

    def test_the_public_factory_refuses_a_path_beside_a_configured_set(self, tmp_path):
        """A path and `lancedb.databases` both place the database."""
        from haiku.rag.config.models import AppConfig, LanceDBConfig
        from haiku.rag.store.exceptions import AmbiguousDatabaseError

        config = AppConfig(
            lancedb=LanceDBConfig(databases={"alpha": str(tmp_path / "a")})
        )

        with pytest.raises(AmbiguousDatabaseError, match="alpha"):
            create_mcp_server(tmp_path / "other.lancedb", config=config)

    @pytest.mark.asyncio
    async def test_the_command_hands_the_server_its_resolved_database(
        self, monkeypatch
    ):
        """`run_mcp` passes the resolved scope, not a path and not a derived
        configuration: the scope keeps both the URI and the name."""
        from haiku.rag.app import HaikuRAGApp
        from haiku.rag.client.scope import DatabaseScope
        from haiku.rag.config.models import AppConfig, LanceDBConfig

        config = AppConfig(
            lancedb=LanceDBConfig(databases={"prod": "s3://bucket/prod.lancedb"})
        )
        seen: dict = {}

        class _Server:
            async def run_stdio_async(self):
                return None

        def fake_covering(scope, config, agents=True):
            seen.update(scope=scope, config=config)
            return _Server()

        monkeypatch.setattr("haiku.rag.app._mcp_server_covering", fake_covering)
        app = HaikuRAGApp(
            scope=DatabaseScope.resolve(config, database_name="prod"), config=config
        )

        await app.run_mcp(transport="stdio")

        [ref] = seen["scope"].databases
        assert ref.name == "prod"
        assert ref.location == "s3://bucket/prod.lancedb"
        # The caller's configuration, not one derived from the ref.
        assert seen["config"].lancedb.databases == {"prod": "s3://bucket/prod.lancedb"}

    @pytest.mark.asyncio
    async def test_startup_fails_when_the_database_cannot_open(self, tmp_path):
        mcp = create_mcp_server(tmp_path / "does-not-exist.lancedb")

        with pytest.raises(FileNotFoundError):
            async with mcp._lifespan_manager():
                pass

    @pytest.mark.asyncio
    async def test_a_second_lifespan_cycle_opens_a_fresh_client(
        self, mcp_db, monkeypatch
    ):
        from haiku.rag.store.engine import Store

        opens = 0
        initialize = Store._initialize

        async def counted(self):
            nonlocal opens
            opens += 1
            return await initialize(self)

        monkeypatch.setattr(Store, "_initialize", counted)

        mcp = create_mcp_server(mcp_db)
        search = await _get_tool(mcp, "search_documents")

        async with mcp._lifespan_manager():
            await search(query="artificial intelligence")
        assert opens == 1

        async with mcp._lifespan_manager():
            blocks = _rendered(await search(query="artificial intelligence"))
        assert opens == 2
        assert blocks

    @pytest.mark.asyncio
    async def test_same_dim_drift_starts(self, mcp_db):
        """Same-dimension identity drift warns on a read-only open and raises
        on a writable one; the server starts, so it opened read-only."""
        from haiku.rag.config import get_config

        drifted = get_config().model_copy(deep=True)
        drifted.embeddings.model.name = "a-different-model"

        async with create_mcp_server(mcp_db, config=drifted)._lifespan_manager():
            pass