@malloy-publisher/server 0.0.382-dev → 0.2.0

package/src/mcp/resource_metadata.ts

@@ -1,47 +0,0 @@
-import type { ResourceMetadata as SdkResourceMetadata } from "@modelcontextprotocol/sdk/server/mcp";
-
-// Define the specific resource types expected as keys
-type McpResourceType = "model" | "source" | "view" | "query" | "notebook";
-
-// Descriptions and usage guidance for different Malloy resource types.
-// Sourced from documentation and adapted for MCP client context.
-// Type assertion ensures compatibility with the SDK's ResourceMetadata,
-// which might include optional fields or an index signature.
-export const RESOURCE_METADATA: Record<
-   McpResourceType | "package" | "project",
-   SdkResourceMetadata // Use the imported SDK type here
-> = {
-   model: {
-      description:
-         "A blueprint organizing your data tables, their connections, and reusable calculations (like 'revenue'). Models contain Sources, Views, and saved Queries.",
-      usage: "This is your main map. Use its `definition` to see the available Sources, Views, and Queries inside (identified by their names or URIs). You can then fetch details for those specific items using `GetResource`. Use the `malloy_executeQuery` tool with queries defined here to get results, typically as structured data tables (JSON). The results might also include styling information suggesting visualizations.",
-   },
-   source: {
-      description:
-         "Represents a table or dataset (like 'orders'), including its columns and any attached calculations (dimensions/measures) or Views.",
-      usage: "Examine the `definition` to understand the structure of this data and see available Views. Use `GetResource` on a View's URI to inspect it, or use the `malloy_executeQuery` tool (referencing the source and potentially a view) to get data results (JSON).",
-   },
-   view: {
-      description:
-         "A saved recipe within a Source for a specific analysis (like 'Top 10 Products').",
-      usage: "Run this predefined analysis using the `malloy_executeQuery` tool (referencing the parent source/model and this view's name) to get results, typically structured data tables (JSON), sometimes with visualization hints.",
-   },
-   query: {
-      description:
-         "Similar to a View, a saved recipe for an analysis, usually stored directly in a Model.",
-      usage: "Run this standard report using the `malloy_executeQuery` tool (referencing the parent model and this query's name) to get results, typically structured data tables (JSON), sometimes with visualization hints.",
-   },
-   notebook: {
-      description:
-         "An interactive document combining notes (Markdown text), Malloy code, and potentially saved queries or results.",
-      usage: "Read the `definition` to explore the analysis steps, notes (Markdown), and code. Identify queries within the notebook cells that you can run using the `malloy_executeQuery` tool to get results (JSON data, visualization hints).",
-   },
-   package: {
-      description: "A folder grouping related Models and Notebooks.",
-      usage: "Use `ListResources` on this Package's URI to discover the Models and Notebooks it contains. You can then use `GetResource` on those items' URIs to explore them further.",
-   },
-   project: {
-      description: "The main workspace folder holding Packages, Models, etc.",
-      usage: "Use `ListResources` on this Project's URI to see the Packages inside and begin navigating your data assets.",
-   },
-};

package/src/mcp/resources/model_resource.ts

@@ -1,153 +0,0 @@
-import {
-   McpServer,
-   ResourceTemplate,
-} from "@modelcontextprotocol/sdk/server/mcp.js";
-import { ProjectStore } from "../../service/project_store";
-import {
-   ModelNotFoundError,
-   PackageNotFoundError,
-   ModelCompilationError,
-} from "../../errors";
-import { handleResourceGet, McpGetResourceError } from "../handler_utils";
-import { RESOURCE_METADATA } from "../resource_metadata";
-import {
-   getNotFoundError,
-   getMalloyErrorDetails,
-   getInternalError,
-} from "../error_messages";
-import type { components } from "../../api"; // Import the components type
-
-/**
- * Registers the Malloy Model resource type with the MCP server.
- * Handles getting details for a specific model.
- */
-export function registerModelResource(
-   mcpServer: McpServer,
-   projectStore: ProjectStore,
-): void {
-   mcpServer.resource(
-      "model",
-      new ResourceTemplate(
-         "malloy://project/{projectName}/package/{packageName}/models/{modelPath}",
-         { list: undefined }, // No list handler for individual models
-      ),
-      /** Handles GetResource requests for specific Malloy Models */
-      (uri, params) =>
-         handleResourceGet(
-            uri,
-            params,
-            "model",
-            async ({
-               projectName,
-               packageName,
-               modelPath,
-            }: {
-               projectName?: unknown;
-               packageName?: unknown;
-               modelPath?: unknown;
-            }) => {
-               try {
-                  // Validate all parameters
-                  if (typeof projectName !== "string") {
-                     throw new Error("Invalid project name parameter.");
-                  }
-                  if (typeof packageName !== "string") {
-                     throw new Error("Invalid package name parameter.");
-                  }
-                  if (typeof modelPath !== "string") {
-                     throw new Error("Invalid model path parameter.");
-                  }
-
-                  // *** UPDATED LOGIC using ProjectStore ***
-                  // getProject can throw ProjectNotFoundError (though unlikely if name is 'home')
-                  const project = await projectStore.getProject(
-                     projectName,
-                     false,
-                  );
-                  // getPackage can throw PackageNotFoundError
-                  const pkg = await project.getPackage(packageName, false);
-                  // getModel is SYNCHRONOUS
-                  const modelInstance = pkg.getModel(modelPath);
-                  // *** END UPDATED LOGIC ***
-
-                  if (
-                     !modelInstance ||
-                     modelInstance.getModelType() === "notebook"
-                  ) {
-                     // Explicitly throw the expected error if not found or wrong type
-                     throw new ModelNotFoundError(modelPath);
-                  }
-
-                  // modelInstance.getModel() is ASYNC and can throw ModelCompilationError
-                  const compiledModelDefinition: components["schemas"]["CompiledModel"] =
-                     await modelInstance.getModel();
-
-                  // Strip implicit filters from agent-facing responses
-                  if (compiledModelDefinition.sources) {
-                     for (const source of compiledModelDefinition.sources) {
-                        if (source.filters) {
-                           source.filters = source.filters.filter(
-                              (f) => !f.implicit,
-                           );
-                        }
-                     }
-                  }
-
-                  return compiledModelDefinition;
-               } catch (error) {
-                  let errorDetails;
-                  // Provide specific context for error messages
-                  // Use validated string parameters here
-                  const safeProjectName =
-                     typeof projectName === "string" ? projectName : "unknown";
-                  const safePackageName =
-                     typeof packageName === "string" ? packageName : "unknown";
-                  const safeModelPath =
-                     typeof modelPath === "string" ? modelPath : "unknown";
-
-                  const notFoundContext = `Model '${safeModelPath}' in package '${safePackageName}' for project '${safeProjectName}'`;
-                  const malloyErrorContext = `${safeProjectName}/${safePackageName}/${safeModelPath}`;
-
-                  if (error instanceof PackageNotFoundError) {
-                     // Package not found during getPackage call
-                     errorDetails = getNotFoundError(
-                        `Package '${safePackageName}' in project '${safeProjectName}'`,
-                     );
-                  } else if (error instanceof ModelNotFoundError) {
-                     // Model not found (either from getModel or type check)
-                     errorDetails = getNotFoundError(notFoundContext);
-                  } else if (error instanceof ModelCompilationError) {
-                     // Compilation error when fetching model definition
-                     errorDetails = getMalloyErrorDetails(
-                        "GetResource (model)",
-                        malloyErrorContext,
-                        error,
-                     );
-                  } else if (error instanceof Error) {
-                     // Catch invalid param errors or other generic errors
-                     // Provide a clearer message differentiating param errors
-                     if (error.message.includes("parameter")) {
-                        errorDetails = getNotFoundError(
-                           `Invalid identifier parameter provided for URI ${uri.href}: ${error.message}`,
-                        );
-                     } else {
-                        errorDetails = getInternalError(
-                           "GetResource (model) - Unexpected Error",
-                           error,
-                        );
-                     }
-                  } else {
-                     // Fallback for truly unexpected non-Error throws
-                     errorDetails = getInternalError(
-                        "GetResource (model)",
-                        error,
-                     );
-                  }
-                  // Wrap and re-throw for handleResourceGet
-                  throw new McpGetResourceError(errorDetails);
-               }
-            },
-            RESOURCE_METADATA.model,
-         ),
-   );
-}

package/src/mcp/resources/notebook_resource.ts

@@ -1,137 +0,0 @@
-import {
-   McpServer,
-   ResourceTemplate,
-} from "@modelcontextprotocol/sdk/server/mcp.js";
-import { URL } from "url";
-import type { components } from "../../api"; // Need this for CompiledModel type
-import {
-   ModelCompilationError,
-   ModelNotFoundError,
-   PackageNotFoundError,
-} from "../../errors";
-import { logger } from "../../logger";
-import { ProjectStore } from "../../service/project_store";
-import {
-   getInternalError,
-   getMalloyErrorDetails,
-   getNotFoundError,
-} from "../error_messages";
-import { handleResourceGet, McpGetResourceError } from "../handler_utils";
-import { RESOURCE_METADATA } from "../resource_metadata";
-
-// Define the expected parameter types
-type NotebookParams = {
-   projectName?: unknown;
-   packageName?: unknown;
-   notebookName?: unknown;
-};
-
-/**
- * Registers the Malloy Notebook resource type.
- * Handles getting details for a specific notebook.
- */
-export function registerNotebookResource(
-   mcpServer: McpServer,
-   projectStore: ProjectStore,
-): void {
-   mcpServer.resource(
-      "notebook",
-      new ResourceTemplate(
-         "malloy://project/{projectName}/package/{packageName}/notebooks/{notebookName}",
-         { list: undefined }, // Listing notebooks is not supported via this template
-      ),
-      (uri, params) =>
-         handleResourceGet(
-            uri,
-            params as NotebookParams,
-            "notebook",
-            async (
-               { projectName, packageName, notebookName }: NotebookParams,
-               uri: URL,
-            ) => {
-               if (
-                  typeof projectName !== "string" ||
-                  typeof packageName !== "string" ||
-                  typeof notebookName !== "string"
-               ) {
-                  throw new Error("Invalid parameters for notebook resource.");
-               }
-
-               let modelInstance;
-               try {
-                  const project = await projectStore.getProject(
-                     projectName,
-                     false,
-                  );
-                  const pkg = await project.getPackage(packageName, false);
-                  // Get the model instance using the notebookName as the path
-                  modelInstance = pkg.getModel(notebookName);
-
-                  // Check if it exists and is actually a notebook
-                  if (
-                     !modelInstance ||
-                     modelInstance.getModelType() !== "notebook"
-                  ) {
-                     const isNotebookError =
-                        modelInstance?.getModelType() !== "notebook";
-                     const errorDetails = getNotFoundError(
-                        `Notebook '${notebookName}' in package '${packageName}' project '${projectName}'${
-                           isNotebookError ? " (not a .malloynb file)" : ""
-                        }`,
-                     );
-                     throw new McpGetResourceError(errorDetails);
-                  }
-
-                  // Now try to get the actual notebook content
-                  const notebookContent: components["schemas"]["RawNotebook"] =
-                     await modelInstance.getNotebook();
-                  return notebookContent;
-               } catch (error) {
-                  if (error instanceof McpGetResourceError) {
-                     throw error; // Re-throw if already formatted by checks above
-                  }
-
-                  // Handle specific errors like PackageNotFoundError or ModelCompilationError
-                  if (error instanceof PackageNotFoundError) {
-                     throw new McpGetResourceError(
-                        getNotFoundError(
-                           `Package '${packageName}' in project '${projectName}'`,
-                        ),
-                     );
-                  }
-                  // Handle ModelCompilationError from modelInstance.getModel()
-                  if (error instanceof ModelCompilationError) {
-                     const malloyErrorContext = `${projectName}/${packageName}/${notebookName}`;
-                     throw new McpGetResourceError(
-                        getMalloyErrorDetails(
-                           "GetResource (notebook compilation)",
-                           malloyErrorContext,
-                           error,
-                        ),
-                     );
-                  }
-                  // Handle ModelNotFoundError specifically from pkg.getModel()
-                  if (error instanceof ModelNotFoundError) {
-                     throw new McpGetResourceError(
-                        getNotFoundError(
-                           `Notebook '${notebookName}' not found in package '${packageName}' project '${projectName}'`,
-                        ),
-                     );
-                  }
-
-                  // Handle other unexpected errors
-                  logger.error(
-                     `[MCP Server Error] Error fetching notebook '${notebookName}' from ${uri.href}:`,
-                     { error },
-                  );
-                  const fallbackErrorDetails = getInternalError(
-                     `GetResource (notebook: ${uri.href})`,
-                     error,
-                  );
-                  throw new McpGetResourceError(fallbackErrorDetails);
-               }
-            },
-            RESOURCE_METADATA.notebook,
-         ),
-   );
-}