feat(mcp): Add test-my-tools prompt with optional scope parameter (#893)

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

Author: aaronsteers

airbyte/mcp/prompts.py

@@ -0,0 +1,72 @@
+# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
+"""MCP prompt definitions for the PyAirbyte MCP server.
+
+This module defines prompts that can be invoked by MCP clients to perform
+common workflows.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Annotated
+
+from pydantic import Field
+
+
+if TYPE_CHECKING:
+    from fastmcp import FastMCP
+
+
+TEST_MY_TOOLS_GUIDANCE = """
+Test all available tools in this MCP server to confirm they are working properly.
+
+Guidelines:
+- Iterate through each tool systematically
+- Use read-only operations whenever possible
+- For tools that modify data, use test/safe modes or skip if no safe testing method exists
+- Avoid creating persistent side effects (e.g., don't create real resources, connections, or data)
+- Document which tools were tested and their status
+- Report any errors or issues encountered
+- Provide a summary of the test results at the end
+
+Focus on validating that tools:
+1. Accept their required parameters correctly
+2. Return expected output formats
+3. Handle errors gracefully
+4. Connect to required services (if applicable)
+
+Be efficient and practical in your testing approach.
+""".strip()
+
+
+def test_my_tools_prompt(
+    scope: Annotated[
+        str | None,
+        Field(
+            description=(
+                "Optional free-form text to focus or constrain testing. "
+                "This can be a single word, a sentence, or a paragraph "
+                "describing the desired scope or constraints."
+            ),
+        ),
+    ] = None,
+) -> list[dict[str, str]]:
+    """Generate a prompt that instructs the agent to test available tools."""
+    content = TEST_MY_TOOLS_GUIDANCE
+
+    if scope:
+        content = f"{content}\n\n---\n\nAdditional scope or constraints:\n{scope}"
+
+    return [
+        {
+            "role": "user",
+            "content": content,
+        }
+    ]
+
+
+def register_prompts(app: FastMCP) -> None:
+    """Register all prompts with the FastMCP app."""
+    app.prompt(
+        name="test-my-tools",
+        description="Test all available MCP tools to confirm they are working properly",
+    )(test_my_tools_prompt)

airbyte/mcp/server.py

@@ -11,6 +11,7 @@
 from airbyte.mcp.cloud_ops import register_cloud_ops_tools
 from airbyte.mcp.connector_registry import register_connector_registry_tools
 from airbyte.mcp.local_ops import register_local_ops_tools
+from airbyte.mcp.prompts import register_prompts
 
 
 set_mcp_mode()
@@ -22,6 +23,7 @@
 register_connector_registry_tools(app)
 register_local_ops_tools(app)
 register_cloud_ops_tools(app)
+register_prompts(app)
 
 
 def main() -> None: