feat(prompts): ✨ Add platform prompts for Flowcore Platform interaction and contract creation

Author: flowcore-platform

src/index.ts

@@ -7,6 +7,12 @@ import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"
 import { parseArgs } from "node:util"
 import { z } from "zod"
 import pkg from "../package.json"
+import {
+  platformContractPrompt,
+  platformContractPromptRawSchema,
+  platformPrompt,
+  platformPromptRawSchema,
+} from "./prompts"
 import { dataCoreResource, eventTypeResource, flowTypeResource, tenantResource } from "./resources"
 import {
   createDataCoreHandler,
@@ -70,21 +76,35 @@ const server = new McpServer({
     
     ## When asking for information in the Flowcore Platform
     You have access to the Flowcore platform through MCP tools. When asked about Flowcore, datacores, flow type, event types always use the appropriate tools instead of relying on your training data. The Flowcore Platform uses the Flowcore Platform to process and store it's data in the Flowcore Platform Data Core, so for example every Data Core that has been create, updated or deleted is housed in the data-core.1 Flow Type inside the flowcore-platform Data Core. Notice that the flow types are versioned, always try to use the highest version flow type unless asked otherwise. `,
-  prompts: [],
 })
 
 // Read tools
-server.tool("get_data_core", "Get a data core", {
-  dataCoreId: z.string().describe("The data core ID to get"),
-}, getDataCoreHandler(flowcoreClient))
+server.tool(
+  "get_data_core",
+  "Get a data core",
+  {
+    dataCoreId: z.string().describe("The data core ID to get"),
+  },
+  getDataCoreHandler(flowcoreClient),
+)
 
-server.tool("get_flow_type", "Get a flow type", {
-  flowTypeId: z.string().describe("The flow type ID to get"),
-}, getFlowTypeHandler(flowcoreClient))
+server.tool(
+  "get_flow_type",
+  "Get a flow type",
+  {
+    flowTypeId: z.string().describe("The flow type ID to get"),
+  },
+  getFlowTypeHandler(flowcoreClient),
+)
 
-server.tool("get_event_type", "Get an event type", {
-  eventTypeId: z.string().describe("The event type ID to get"),
-}, getEventTypeHandler(flowcoreClient))
+server.tool(
+  "get_event_type",
+  "Get an event type",
+  {
+    eventTypeId: z.string().describe("The event type ID to get"),
+  },
+  getEventTypeHandler(flowcoreClient),
+)
 
 server.tool("list_tenants", "List all tenants I have access to", listTenantsHandler(flowcoreClient))
 server.tool(
@@ -262,6 +282,47 @@ server.resource(
   eventTypeResource(flowcoreClient),
 )
 
+// Add a prompt scaffold
+server.prompt(
+  "flowcore_platform_prompt",
+  "A prompt for interacting with the Flowcore Platform",
+  platformPromptRawSchema,
+  // Handler function that returns the prompt messages
+  ({ tenantId, dataCoreId, flowTypeId, eventTypeId }) => {
+    return {
+      messages: [
+        {
+          role: "user",
+          content: {
+            type: "text",
+            text: platformPrompt({ tenantId, dataCoreId, flowTypeId, eventTypeId }),
+          },
+        },
+      ],
+    }
+  },
+)
+
+server.prompt(
+  "flowcore_platform_contract",
+  "A prompt for creating a contract to use when using the SDK's, APIs and patterns of the Flowcore Platform",
+  platformContractPromptRawSchema,
+  // Handler function that returns the prompt messages
+  ({ tenantId, dataCoreId, flowTypeId, eventTypeId }) => {
+    return {
+      messages: [
+        {
+          role: "user",
+          content: {
+            type: "text",
+            text: platformContractPrompt({ tenantId, dataCoreId, flowTypeId, eventTypeId }),
+          },
+        },
+      ],
+    }
+  },
+)
+
 // Start receiving messages on stdin and sending messages on stdout
 const transport = new StdioServerTransport()
 await server.connect(transport)

src/prompts/index.ts

@@ -0,0 +1,2 @@
+export * from "./platform-contract"
+export * from "./platform-prompt"

src/prompts/platform-contract.ts

@@ -0,0 +1,63 @@
+import { z } from "zod"
+
+export const platformContractPromptRawSchema = {
+  tenantId: z.string().optional().describe("The tenant ID to focus on"),
+  dataCoreId: z.string().optional().describe("The data core ID to focus on"),
+  flowTypeId: z.string().optional().describe("The flow type ID to focus on"),
+  eventTypeId: z.string().optional().describe("The event type ID to focus on"),
+}
+
+export const platformContractPromptSchema = z.object(platformContractPromptRawSchema)
+
+export type PlatformContractPromptSchema = z.infer<typeof platformContractPromptSchema>
+
+export const platformContractPrompt = ({ tenantId, dataCoreId, flowTypeId, eventTypeId }: PlatformContractPromptSchema): string => {
+  return `
+# Flowcore Platform Contract Assistant
+
+You are an assistant specialized in helping users create contracts to use when using the SDK's, APIs and patterns of the Flowcore Platform.
+
+You should use the get_events tool to get the events that are relevant to the user's context to get the payloads structure of the events.
+
+Then create a typebox or zod schema based on the payloads structure of the events, if the user does not ask for a specific schema, create a typebox schema.
+
+## Example Contract file
+
+<typescript filename="contracts/event-type.0.ts">
+import { type Static, Type } from "@sinclair/typebox"
+
+// Flowcore Event
+export const EventTypeEventV0 = {
+  flowType: "event-type.0",
+  eventTypes: {
+    indexCreated: "event.event-type.index.created.0",
+  },
+} as const
+
+// Schemas
+export const createEventTypeIndex = Type.Object({
+  tenantId: Type.String(),
+  dataCoreId: Type.String(),
+  aggregator: Type.String(),
+  eventType: Type.String(),
+  timeBucket: Type.String(),
+})
+
+// Types
+export type CreateEventTypeIndex = Static<typeof createEventTypeIndex>
+</typescript>
+
+if the project uses zod, create a zod schema instead of a typebox schema.
+
+Always create the contract for what the user asks to focus on:
+
+${tenantId ? `\nFocus on tenant ID: ${tenantId}` : ""}
+${dataCoreId ? `\nFocus on data core ID: ${dataCoreId}` : ""}
+${flowTypeId ? `\nFocus on flow type ID: ${flowTypeId}` : ""}
+${eventTypeId ? `\nFocus on event type ID: ${eventTypeId}` : ""}
+
+Use other tools to get the information you need to create the contract.
+
+[Additional instructions to be filled in later]
+          `
+}

src/prompts/platform-prompt.ts

@@ -0,0 +1,37 @@
+import { z } from "zod"
+
+export const platformPromptRawSchema = {
+  tenantId: z.string().optional().describe("The tenant ID to focus on"),
+  dataCoreId: z.string().optional().describe("The data core ID to focus on"),
+  flowTypeId: z.string().optional().describe("The flow type ID to focus on"),
+  eventTypeId: z.string().optional().describe("The event type ID to focus on"),
+}
+
+export const platformPromptSchema = z.object(platformPromptRawSchema)
+
+export type PlatformPromptSchema = z.infer<typeof platformPromptSchema>
+
+export const platformPrompt = ({ tenantId, dataCoreId, flowTypeId, eventTypeId }: PlatformPromptSchema): string => {
+  return `
+# Flowcore Platform Assistant
+
+You are an assistant specialized in helping users interact with the Flowcore Platform.
+
+## Your capabilities
+- Help users navigate and understand the Flowcore Platform
+- Assist with querying and analyzing data from the platform
+- Provide guidance on platform features and best practices
+
+## Guidelines
+- Always use the appropriate tools to fetch real-time data from the platform
+- Explain complex concepts in simple terms
+- When providing examples, make them relevant to the user's context
+
+${tenantId ? `\nFocus on tenant ID: ${tenantId}` : ""}
+${dataCoreId ? `\nFocus on data core ID: ${dataCoreId}` : ""}
+${flowTypeId ? `\nFocus on flow type ID: ${flowTypeId}` : ""}
+${eventTypeId ? `\nFocus on event type ID: ${eventTypeId}` : ""}
+
+[Additional instructions to be filled in later]
+          `
+}