Save progress for now

Author: Ickerday

pyproject.toml

@@ -31,6 +31,8 @@ classifiers = [
 
 dependencies = [
     "fastmcp>=2.12.4",
+    "httpx>=0.28.1",
+    "mcp>=1.15.0",
     "python-dotenv>=0.21.1",
 ]
 optional-dependencies = { compat = ["six>=1.17.0"] }
@@ -75,5 +77,3 @@ select = [
   "RUF", # ruff-specific rules
 ]
 
-[tool.uv.workspace]
-members = ["tests/system/test_apps/mcp_enabled_app"]

splunklib/mcp/mcp.py

@@ -0,0 +1,28 @@
+import httpx
+from mcp.types import Tool as MCPTool
+
+from splunklib.mcp.tools.models import AddTool, AddToolsRequest
+
+
+async def send_mcp_registrations(
+    endpoint_url: str,
+    tool_registrations: list[MCPTool],
+    server_file_path: str,
+):
+    async with httpx.AsyncClient() as client:
+        add_req = AddToolsRequest(
+            tools=[
+                AddTool(script_path=server_file_path, spec=tool)
+                for tool in tool_registrations
+            ]
+        )
+
+        res = await client.post(endpoint_url, json=add_req.model_dump())
+        print(res.status_code)
+        print(res.text)
+
+
+async def execute_tool(endpoint_url: str):
+    async with httpx.AsyncClient() as client:
+        res = await client.post(endpoint_url)
+        print(res.text)

splunklib/mcp/tools/models.py

@@ -0,0 +1,62 @@
+from dataclasses import field
+from typing import Any, Literal
+
+from fastmcp.client import Client
+from fastmcp.server.dependencies import get_context
+from fastmcp.tools import Tool as FastMCPTool
+from fastmcp.tools.tool import ToolResult
+from mcp.types import Tool as MCPTool
+from pydantic.main import BaseModel
+from typing_extensions import override
+
+
+class SplunkMeta(BaseModel):
+    permissions: list[str] = field(default=[])
+    tool_type: str = field(default="")
+    schema_version: str = field(default="")
+    execution_mode: str = field(default="")
+    execution_endpoint: str = field(default="")
+
+
+class McpInputOutputSchema(BaseModel):
+    type: Literal["object"] = "object"
+    properties: dict[str, Any] = field(default_factory=lambda: {})  # pyright: ignore[reportExplicitAny]
+    required: list[str] = field(default_factory=lambda: [])
+
+
+class AddTool(BaseModel):
+    script_path: str
+    spec: MCPTool
+
+
+class AddToolsRequest(BaseModel):
+    tools: list[AddTool]
+
+
+class DeleteToolsRequest(BaseModel):
+    tools: list[str]
+
+
+class ProxiedTool(FastMCPTool):
+    script: str
+
+    @override
+    async def run(self, arguments: dict[str, Any]) -> ToolResult:  # pyright: ignore[reportExplicitAny]
+        async def progress_handler(
+            progress: float, total: float | None, message: str | None
+        ) -> None:
+            await get_context().report_progress(progress, total, message)
+
+        c = Client(transport=self.script)
+
+        async with c:
+            res = await c.call_tool(
+                self.name, arguments, progress_handler=progress_handler
+            )
+
+            # TODO: we are missing some fields ....
+            # res.is_error
+            # res.data
+            return ToolResult(
+                content=res.content, structured_content=res.structured_content
+            )

splunklib/mcp/tools.py renamed to splunklib/mcp/tools/registrations.py

@@ -1,28 +1,14 @@
 import configparser
-import os
-from dataclasses import asdict, dataclass, field
-from typing import Any, Literal
+from dataclasses import asdict
+from typing import Literal
 
 from fastmcp.client import Client
-from fastmcp.client.transports import PythonStdioTransport
-from mcp.types import Tool
-
-
-@dataclass
-class SplunkMeta:
-    permissions: list[str] = field()
-    tool_type: str = field(default="")
-    schema_version: str = field(default="")
-    execution_mode: str = field(default="")
-    execution_endpoint: str = field(default="")
-
-
-@dataclass
-class McpInputOutputSchema:
-    type: Literal["object"] = "object"
-    properties: dict[str, Any] = field(default_factory=lambda: {})  # pyright: ignore[reportExplicitAny]
-    required: list[str] = field(default_factory=lambda: [])
+from mcp.types import Tool as MCPTool
 
+from splunklib.mcp.tools.models import (
+    McpInputOutputSchema,
+    SplunkMeta,
+)
 
 tool_reg_prefix = "app:mcp_tool"
 
@@ -48,7 +34,7 @@ def match_input_schema(input: Literal["query_string"] | Literal["other"]):
             raise NotImplementedError("We don't know what to put here lol")
 
 
-def parse_ai_conf(file_path: str) -> list[Tool]:
+def parse_ai_conf(file_path: str) -> list[MCPTool]:
     config = configparser.ConfigParser()
     all_sections_len = config.read(file_path)
     if len(all_sections_len) == 0:
@@ -88,23 +74,12 @@ def parse_ai_conf(file_path: str) -> list[Tool]:
     return ini_tools
 
 
-async def get_tools(server_path: str):
+async def get_mcp_tools(server_path: str) -> list[MCPTool]:
+    """Connects to local MCP server to get tools registered with a @tool decorator"""
     mcp_client = Client(server_path)
 
-    tools = []
+    tools: list[MCPTool] = []
     async with mcp_client:
         tools = await mcp_client.list_tools()
 
-        # TODO: Get registrations from ai.conf
-        # curr_path = os.path.join(os.getcwd(), "..", "default", "app.conf")
-        # yaml_tool_registrations: list[Tool] = parse_ai_conf(curr_path)
-
     return tools
-
-
-async def register_tools_from(file_paths: list[str]) -> None:
-    """TODO
-    1. `POST /tools` with MCP payload
-    2.
-    """
-    print(file_paths)

tests/system/test_apps/mcp_enabled_app/README.md

@@ -13,3 +13,7 @@ This example aspires to verify the points listed in [POC - AI with Splunk Apps](
 - Run `uv sync`
 - `source .venv/bin/activate`
 - Run the code blocks `bin/mcp_enabled_app.ipynb`
+
+## TODO
+
+- Research using server composition: <https://gofastmcp.com/servers/composition>

tests/system/test_apps/mcp_enabled_app/bin/execute_tool_example.py

@@ -0,0 +1,12 @@
+import asyncio
+
+
+def execute_tool_example(endpoint_url: str):
+    pass
+
+
+if __name__ == "__main__":
+    MCP_SERVER_HOST: str = "0.0.0.0"
+    MCP_SERVER_PORT: int = 2137
+
+    asyncio.run(execute_tool_example(""))

tests/system/test_apps/mcp_enabled_app/bin/mcp_enabled_app.ipynb

@@ -13,14 +13,6 @@
     "  - [ ] Capture e.g. tool_name, description, inputs, outputs\n"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "18ab5550",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  },
   {
    "cell_type": "markdown",
    "id": "363201e8",

tests/system/test_apps/mcp_enabled_app/bin/mcp_tools.py

@@ -0,0 +1,64 @@
+import asyncio
+import json
+import time
+
+from fastmcp import Context, FastMCP
+
+from splunklib import client
+from splunklib.mcp.tools.models import SplunkMeta
+from splunklib.results import JSONResultsReader
+
+app_mcp_server = FastMCP("GeneratingCSC PoC Server")
+
+
+@app_mcp_server.tool(
+    description="""
+    The `generatingcsc` command generates a specific number of records.
+    
+    Example:
+    ``| generatingcsc count=4``
+    Returns a 4 records having text 'Test Event'.
+    """,
+    meta=SplunkMeta(
+        permissions=["role:search_admin", "role:aws_analyst"],
+        tool_type="search",
+        schema_version="1.0",
+        execution_endpoint="",
+        execution_mode="",
+    ).model_dump(),
+    enabled=True,
+)
+async def generating_csc(count: int, ctx: Context) -> list[str]:
+    service = client.connect(
+        scheme="https",
+        host="localhost",
+        port="8089",
+        username="admin",
+        password="changed!",
+        autologin=True,
+    )
+    stream = service.jobs.oneshot(
+        f"| generatingcsc count={abs(count)}", output_mode="json"
+    )
+    results: JSONResultsReader = JSONResultsReader(stream)
+    for progress in range(0, 5):
+        await ctx.report_progress((progress + 1) * 2, 100, "Addition in progress")
+        time.sleep(0.25)
+
+    quuuuuux = [json.dumps(r) for r in list(results)]
+    print(quuuuuux)
+    return quuuuuux
+
+
+if __name__ == "__main__":
+    MCP_SERVER_HOST: str = "0.0.0.0"
+    MCP_SERVER_PORT: int = 2137
+
+    app_mcp_server.run("stdio", show_banner=False)
+    # asyncio.run(
+    #     app_mcp_server.run_async(
+    #         show_banner=False,
+    #         # host=MCP_SERVER_HOST,
+    #         # port=MCP_SERVER_PORT
+    #     )
+    # )

tests/system/test_apps/mcp_enabled_app/bin/post_install_example.py

@@ -1,10 +1,24 @@
-from splunklib.mcp import tools
+import asyncio
+import os
 
+from splunklib.mcp.mcp import send_mcp_registrations
+from splunklib.mcp.tools import registrations
 
-async def post_install(splunk_url: str, auth_token: str) -> None:
-    # TODO: Implement
-    try:
-        await tools.register_tools_from(["./tools.py", "../local/ai.conf"])
-    except Exception as e:
-        print(e)
-        raise e
+
+async def post_install(server_file_path: str, endpoint_url: str) -> None:
+    tool_registrations = await registrations.get_mcp_tools(server_file_path)
+
+    await send_mcp_registrations(
+        endpoint_url,
+        tool_registrations,
+        server_file_path,
+    )
+
+
+if __name__ == "__main__":
+    asyncio.run(
+        post_install(
+            f"{os.getcwd()}/tests/system/test_apps/mcp_enabled_app/bin/mcp_tools.py",
+            "http://0.0.0.0:8090/tools",
+        )
+    )