spix_playbook_show

Instructions

Implementation Reference

• src/spix_mcp/registry.py:107-118 (schema)

  The CommandSchema definition for the 'playbook.show' tool. It defines the MCP tool name 'spix_playbook_show', the API endpoint '/playbooks/{playbook_id}', HTTP method GET, and requires a 'playbook_id' positional argument. This is the schema that defines the tool.

  CommandSchema(
      path="playbook.show",
      cli_usage="spix playbook show <playbook_id>",
      http_method="GET",
      api_endpoint="/playbooks/{playbook_id}",
      mcp_expose="tool",
      mcp_profile="safe",
      description="Show playbook details",
      positional_args=[
          CommandParam("playbook_id", "string", required=True, description="Playbook ID"),
      ],
  ),

• src/spix_mcp/server.py:84-106 (registration)

  Registration of MCP tools. At line 90, the tool name is constructed as 'spix_playbook_show' from the schema path 'playbook.show'. Tools are registered with the MCP server via list_tools() and dispatched via call_tool() which delegates to create_tool_handler.

  # ─── Tool Surface ─────────────────────────────────────────────────────────
  tool_schemas = get_mcp_tools(profile=tool_profile, disabled=disabled_tools)
  tool_defs: list[Tool] = []
  
  for schema in tool_schemas:
      # Convert path to tool name: playbook.create -> spix_playbook_create
      tool_name = f"spix_{schema.path.replace('.', '_')}"
      tool_defs.append(
          Tool(
              name=tool_name,
              description=schema.description or f"Spix {schema.path}",
              inputSchema=build_json_schema(schema),
          )
      )
  
  @server.list_tools()
  async def list_tools() -> list[Tool]:
      return tool_defs
  
  @server.call_tool()
  async def call_tool(name: str, arguments: dict) -> Sequence[TextContent]:
      result = await create_tool_handler(session, name, arguments)
      return result

• src/spix_mcp/tools.py:94-203 (handler)

  The generic tool handler (create_tool_handler) that processes all tool calls including 'spix_playbook_show'. It uses get_schema_by_tool_name() to look up the playbook.show schema, then builds the endpoint URL '/playbooks/{playbook_id}' by substituting the playbook_id path parameter, and executes a GET request via the API client.

  async def create_tool_handler(
      session: McpSessionContext,
      tool_name: str,
      arguments: dict,
  ) -> list:
      """Execute an MCP tool call by dispatching to the backend API.
  
      This function:
      1. Resolves the tool name to a command schema
      2. Validates session scope (playbook access, channel access)
      3. Builds the API request
      4. Dispatches to the backend
      5. Returns the response as MCP TextContent
  
      Args:
          session: The MCP session context for scope validation.
          tool_name: The MCP tool name (e.g., "spix_playbook_create").
          arguments: The tool arguments from the MCP client.
  
      Returns:
          List containing a single TextContent with the JSON response.
      """
      # Import here to avoid circular imports and handle missing mcp package
      try:
          from mcp.types import TextContent
      except ImportError:
          # Fallback for when mcp is not installed
          class TextContent:  # type: ignore[no-redef]
              def __init__(self, type: str, text: str) -> None:
                  self.type = type
                  self.text = text
  
      # Resolve tool name to schema
      schema = get_schema_by_tool_name(tool_name)
      if not schema:
          return [
              TextContent(
                  type="text",
                  text=orjson.dumps(
                      {"ok": False, "error": {"code": "unknown_tool", "message": f"Unknown tool: {tool_name}"}}
                  ).decode(),
              )
          ]
  
      # Validate tool access (not disabled)
      try:
          session.validate_tool_access(schema.path)
      except Exception as e:
          from spix_mcp.session import McpScopeError
  
          if isinstance(e, McpScopeError):
              return [TextContent(type="text", text=orjson.dumps({"ok": False, "error": e.to_dict()}).decode())]
          raise
  
      # Validate channel access if applicable
      channel = infer_channel_from_tool(schema.path)
      if channel:
          try:
              session.validate_channel_access(channel)
          except Exception as e:
              from spix_mcp.session import McpScopeError
  
              if isinstance(e, McpScopeError):
                  return [TextContent(type="text", text=orjson.dumps({"ok": False, "error": e.to_dict()}).decode())]
              raise
  
      # Handle playbook_id: validate and apply default
      playbook_id = arguments.get("playbook_id")
      try:
          effective_playbook = session.validate_playbook_access(playbook_id)
          if effective_playbook and not playbook_id:
              # Apply default playbook
              arguments["playbook_id"] = effective_playbook
      except Exception as e:
          from spix_mcp.session import McpScopeError
  
          if isinstance(e, McpScopeError):
              return [TextContent(type="text", text=orjson.dumps({"ok": False, "error": e.to_dict()}).decode())]
          raise
  
      # Build endpoint URL with path parameters
      endpoint, remaining_args = build_endpoint_url(schema, arguments)
  
      # Dispatch to backend API
      client = session.client
      method = schema.http_method.lower()
  
      if method == "get":
          response = await asyncio.to_thread(client.get, endpoint, params=remaining_args if remaining_args else None)
      elif method == "post":
          response = await asyncio.to_thread(client.post, endpoint, json=remaining_args if remaining_args else None)
      elif method == "patch":
          response = await asyncio.to_thread(client.patch, endpoint, json=remaining_args if remaining_args else None)
      elif method == "delete":
          response = await asyncio.to_thread(client.delete, endpoint, params=remaining_args if remaining_args else None)
      else:
          response = await asyncio.to_thread(client.get, endpoint)
  
      # Build response envelope
      envelope: dict = {"ok": response.ok, "meta": response.meta}
      if response.ok:
          envelope["data"] = response.data
          if response.pagination:
              envelope["pagination"] = response.pagination
          if response.warnings:
              envelope["warnings"] = response.warnings
      else:
          envelope["error"] = response.error
  
      return [TextContent(type="text", text=orjson.dumps(envelope).decode())]

• src/spix_mcp/registry.py:23-48 (helper)

  The get_schema_by_tool_name() function in tools.py (lines 23-50) resolves the MCP tool name 'spix_playbook_show' back to the 'playbook.show' CommandSchema by converting underscores to dots and matching against the registry.

      required: bool = False
      description: str = ""
      choices: list[str] = field(default_factory=list)
      default: object = None
  
  
  @dataclass
  class CommandSchema:
      """Schema for a CLI command.
  
      Each command maps to:
      - A Click command in the CLI
      - Optionally an MCP tool or resource
      """
  
      path: str  # e.g., "playbook.create", "call.show"
      cli_usage: str  # e.g., "spix playbook create"
      http_method: str  # "GET", "POST", "PATCH", "DELETE"
      api_endpoint: str  # e.g., "/playbooks", "/calls/{id}"
      params: list[CommandParam] = field(default_factory=list)
      positional_args: list[CommandParam] = field(default_factory=list)
      mcp_expose: Literal["tool", "resource", None] = None
      mcp_profile: Literal["safe", "full"] = "safe"  # "safe" = included in both profiles
      destructive: bool = False
      financial: bool = False
      description: str = ""