@pikku/inspector 0.7.7 → 0.8.0

package/src/add-mcp-resource.ts

@@ -0,0 +1,112 @@
+import * as ts from 'typescript'
+import { getPropertyValue } from './get-property-value.js'
+import { PikkuEventTypes } from '@pikku/core'
+import { InspectorFilters, InspectorState } from './types.js'
+import {
+  extractFunctionName,
+  getPropertyAssignmentInitializer,
+  matchesFilters,
+} from './utils.js'
+
+export const addMCPResource = (
+  node: ts.Node,
+  checker: ts.TypeChecker,
+  state: InspectorState,
+  filters: InspectorFilters
+) => {
+  if (!ts.isCallExpression(node)) {
+    return
+  }
+
+  const args = node.arguments
+  const firstArg = args[0]
+  const expression = node.expression
+
+  // Check if the call is to addMCPResource
+  if (!ts.isIdentifier(expression) || expression.text !== 'addMCPResource') {
+    return
+  }
+
+  if (!firstArg) {
+    return
+  }
+
+  if (ts.isObjectLiteralExpression(firstArg)) {
+    const obj = firstArg
+
+    const uriValue = getPropertyValue(obj, 'uri') as string | null
+    const titleValue = getPropertyValue(obj, 'title') as string | null
+    const descriptionValue = getPropertyValue(obj, 'description') as
+      | string
+      | null
+    const streamingValue = getPropertyValue(obj, 'streaming') as boolean | null
+    const tags = (getPropertyValue(obj, 'tags') as string[]) || undefined
+
+    const funcInitializer = getPropertyAssignmentInitializer(
+      obj,
+      'func',
+      true,
+      checker
+    )
+    if (!funcInitializer) {
+      console.error(
+        `• No valid 'func' property for MCP resource '${uriValue}'.`
+      )
+      return
+    }
+
+    const pikkuFuncName = extractFunctionName(
+      funcInitializer,
+      checker
+    ).pikkuFuncName
+
+    if (!uriValue) {
+      console.error(`• MCP resource is missing the required 'uri' property.`)
+      return
+    }
+
+    if (!titleValue) {
+      console.error(
+        `• MCP resource '${uriValue}' is missing the required 'title' property.`
+      )
+      return
+    }
+
+    if (!descriptionValue) {
+      console.error(`• MCP resource '${uriValue}' is missing a description.`)
+      return
+    }
+
+    if (
+      !matchesFilters(
+        filters,
+        { tags },
+        { type: PikkuEventTypes.mcp, name: uriValue }
+      )
+    ) {
+      return
+    }
+
+    // lookup existing function metadata
+    const fnMeta = state.functions.meta[pikkuFuncName]
+    if (!fnMeta) {
+      console.error(`• No function metadata found for '${pikkuFuncName}'.`)
+      return
+    }
+    const inputSchema = fnMeta.inputs?.[0] || null
+    const outputSchema = fnMeta.outputs?.[0] || null
+
+    state.mcpEndpoints.files.add(node.getSourceFile().fileName)
+
+    state.mcpEndpoints.resourcesMeta[uriValue] = {
+      pikkuFuncName,
+      uri: uriValue,
+      title: titleValue,
+      description: descriptionValue,
+      ...(streamingValue !== null && { streaming: streamingValue }),
+      tags,
+      inputSchema,
+      outputSchema,
+    }
+  }
+}

package/src/add-mcp-tool.ts

@@ -0,0 +1,103 @@
+import * as ts from 'typescript'
+import { getPropertyValue } from './get-property-value.js'
+import { PikkuEventTypes } from '@pikku/core'
+import { InspectorFilters, InspectorState } from './types.js'
+import {
+  extractFunctionName,
+  getPropertyAssignmentInitializer,
+  matchesFilters,
+} from './utils.js'
+
+export const addMCPTool = (
+  node: ts.Node,
+  checker: ts.TypeChecker,
+  state: InspectorState,
+  filters: InspectorFilters
+) => {
+  if (!ts.isCallExpression(node)) {
+    return
+  }
+
+  const args = node.arguments
+  const firstArg = args[0]
+  const expression = node.expression
+
+  // Check if the call is to addMCPTool
+  if (!ts.isIdentifier(expression) || expression.text !== 'addMCPTool') {
+    return
+  }
+
+  if (!firstArg) {
+    return
+  }
+
+  if (ts.isObjectLiteralExpression(firstArg)) {
+    const obj = firstArg
+
+    const nameValue = getPropertyValue(obj, 'name') as string | null
+    const titleValue = getPropertyValue(obj, 'title') as string | null
+    const descriptionValue = getPropertyValue(obj, 'description') as
+      | string
+      | null
+    const streamingValue = getPropertyValue(obj, 'streaming') as boolean | null
+    const tags = (getPropertyValue(obj, 'tags') as string[]) || undefined
+
+    const funcInitializer = getPropertyAssignmentInitializer(
+      obj,
+      'func',
+      true,
+      checker
+    )
+    if (!funcInitializer) {
+      console.error(`• No valid 'func' property for MCP tool '${nameValue}'.`)
+      return
+    }
+
+    const pikkuFuncName = extractFunctionName(
+      funcInitializer,
+      checker
+    ).pikkuFuncName
+
+    if (!nameValue) {
+      console.error(`• MCP tool is missing the required 'name' property.`)
+      return
+    }
+
+    if (!descriptionValue) {
+      console.error(`• MCP tool '${nameValue}' is missing a description.`)
+      return
+    }
+
+    if (
+      !matchesFilters(
+        filters,
+        { tags },
+        { type: PikkuEventTypes.mcp, name: nameValue }
+      )
+    ) {
+      return
+    }
+
+    // lookup existing function metadata
+    const fnMeta = state.functions.meta[pikkuFuncName]
+    if (!fnMeta) {
+      console.error(`• No function metadata found for '${pikkuFuncName}'.`)
+      return
+    }
+    const inputSchema = fnMeta.inputs?.[0] || null
+    const outputSchema = fnMeta.outputs?.[0] || null
+
+    state.mcpEndpoints.files.add(node.getSourceFile().fileName)
+
+    state.mcpEndpoints.toolsMeta[nameValue] = {
+      pikkuFuncName,
+      name: nameValue,
+      title: titleValue || undefined,
+      description: descriptionValue,
+      ...(streamingValue !== null && { streaming: streamingValue }),
+      tags,
+      inputSchema,
+      outputSchema,
+    }
+  }
+}

package/src/add-queue-worker.ts

@@ -0,0 +1,88 @@
+import * as ts from 'typescript'
+import { getPropertyValue } from './get-property-value.js'
+import { APIDocs, PikkuEventTypes } from '@pikku/core'
+import { InspectorFilters, InspectorState } from './types.js'
+import {
+  extractFunctionName,
+  getPropertyAssignmentInitializer,
+  matchesFilters,
+} from './utils.js'
+
+export const addQueueWorker = (
+  node: ts.Node,
+  checker: ts.TypeChecker,
+  state: InspectorState,
+  filters: InspectorFilters
+) => {
+  if (!ts.isCallExpression(node)) {
+    return
+  }
+
+  const args = node.arguments
+  const firstArg = args[0]
+  const expression = node.expression
+
+  // Check if the call is to addQueueWorker
+  if (!ts.isIdentifier(expression) || expression.text !== 'addQueueWorker') {
+    return
+  }
+
+  if (!firstArg) {
+    return
+  }
+
+  if (ts.isObjectLiteralExpression(firstArg)) {
+    const obj = firstArg
+
+    const queueName = getPropertyValue(obj, 'queueName') as string | null
+    const docs = (getPropertyValue(obj, 'docs') as APIDocs) || undefined
+    const tags = (getPropertyValue(obj, 'tags') as string[]) || undefined
+
+    // --- find the referenced function ---
+    const funcInitializer = getPropertyAssignmentInitializer(
+      obj,
+      'func',
+      true,
+      checker
+    )
+    if (!funcInitializer) {
+      console.error(
+        `• No valid 'func' property for queue processor '${queueName}'.`
+      )
+      return
+    }
+
+    const pikkuFuncName = extractFunctionName(
+      funcInitializer,
+      checker
+    ).pikkuFuncName
+
+    if (!queueName) {
+      console.error(
+        `• No 'queueName' provided for queue processor function '${pikkuFuncName}'.`
+      )
+      return
+    }
+
+    if (
+      !matchesFilters(
+        filters,
+        { tags },
+        { type: PikkuEventTypes.queue, name: queueName }
+      )
+    ) {
+      console.info(
+        `• Skipping queue processor '${pikkuFuncName}' for queue '${queueName}' due to filter mismatch.`
+      )
+      return
+    }
+
+    state.queueWorkers.files.add(node.getSourceFile().fileName)
+    state.queueWorkers.meta[queueName] = {
+      pikkuFuncName,
+      queueName,
+      docs,
+      tags,
+    }
+  }
+}

package/src/add-schedule.ts

@@ -1,8 +1,12 @@
 import * as ts from 'typescript'
 import { getPropertyValue } from './get-property-value.js'
-import { APIDocs } from '@pikku/core'
+import { APIDocs, PikkuEventTypes } from '@pikku/core'
 import { InspectorFilters, InspectorState } from './types.js'
-import { extractFunctionName, matchesFilters } from './utils.js'
+import {
+  extractFunctionName,
+  getPropertyAssignmentInitializer,
+  matchesFilters,
+} from './utils.js'
 
 export const addSchedule = (
   node: ts.Node,
@@ -35,22 +39,21 @@ export const addSchedule = (
     const docs = (getPropertyValue(obj, 'docs') as APIDocs) || undefined
     const tags = (getPropertyValue(obj, 'tags') as string[]) || undefined
 
-    // --- find the referenced function ---
-    const funcProp = obj.properties.find(
-      (p) =>
-        ts.isPropertyAssignment(p) &&
-        ts.isIdentifier(p.name) &&
-        p.name.text === 'func'
-    ) as ts.PropertyAssignment | undefined
-
-    if (!funcProp || !ts.isIdentifier(funcProp.initializer)) {
+    const funcInitializer = getPropertyAssignmentInitializer(
+      obj,
+      'func',
+      true,
+      checker
+    )
+    if (!funcInitializer) {
       console.error(
         `• No valid 'func' property for scheduled task '${nameValue}'.`
       )
       return
     }
+
     const pikkuFuncName = extractFunctionName(
-      funcProp.initializer,
+      funcInitializer,
       checker
     ).pikkuFuncName
 
@@ -59,7 +62,11 @@ export const addSchedule = (
     }
 
     if (
-      !matchesFilters(filters, { tags }, { type: 'schedule', name: nameValue })
+      !matchesFilters(
+        filters,
+        { tags },
+        { type: PikkuEventTypes.scheduled, name: nameValue }
+      )
     ) {
       return
     }

package/src/inspector.ts

@@ -49,9 +49,19 @@ export const inspect = (
       meta: {},
       files: new Set(),
     },
+    queueWorkers: {
+      meta: {},
+      files: new Set(),
+    },
     rpc: {
       meta: {},
     },
+    mcpEndpoints: {
+      resourcesMeta: {},
+      toolsMeta: {},
+      promptsMeta: {},
+      files: new Set(),
+    },
   }
 
   // First sweep: add all functions

package/src/types.ts

@@ -1,9 +1,11 @@
 import { ChannelsMeta } from '@pikku/core/channel'
 import { HTTPRoutesMeta } from '@pikku/core/http'
 import { ScheduledTasksMeta } from '@pikku/core/scheduler'
+import { queueWorkersMeta } from '@pikku/core/queue'
+import { MCPResourceMeta, MCPToolMeta, MCPPromptMeta } from '@pikku/core'
 import { TypesMap } from './types-map.js'
 import { FunctionsMeta } from '@pikku/core'
-import { RPCMeta } from '../../core/src/rpc/rpc-types.js'
+import { RPCMeta } from '@pikku/core/rpc'
 
 export type PathToNameAndType = Map<
   string,
@@ -53,7 +55,17 @@ export interface InspectorState {
     meta: ScheduledTasksMeta
     files: Set<string>
   }
+  queueWorkers: {
+    meta: queueWorkersMeta
+    files: Set<string>
+  }
   rpc: {
     meta: Record<string, RPCMeta>
   }
+  mcpEndpoints: {
+    resourcesMeta: MCPResourceMeta
+    toolsMeta: MCPToolMeta
+    promptsMeta: MCPPromptMeta
+    files: Set<string>
+  }
 }

package/src/utils.ts

@@ -1,5 +1,6 @@
 import * as ts from 'typescript'
 import { InspectorFilters } from './types.js'
+import { PikkuEventTypes } from '@pikku/core'
 
 type ExtractedFunctionName = {
   pikkuFuncName: string
@@ -843,7 +844,10 @@ export function getPropertyAssignmentInitializer(
 export const matchesFilters = (
   filters: InspectorFilters,
   params: { tags?: string[] },
-  meta: { type: 'schedule' | 'http' | 'channel'; name: string }
+  meta: {
+    type: PikkuEventTypes
+    name: string
+  }
 ) => {
   if (Object.keys(filters).length === 0 || filters.tags?.length === 0) {
     return true

package/src/visit.ts

@@ -3,6 +3,10 @@ import { addFileWithFactory } from './add-file-with-factory.js'
 import { addFileExtendsCoreType } from './add-file-extends-core-type.js'
 import { addHTTPRoute } from './add-http-route.js'
 import { addSchedule } from './add-schedule.js'
+import { addQueueWorker } from './add-queue-worker.js'
+import { addMCPResource } from './add-mcp-resource.js'
+import { addMCPTool } from './add-mcp-tool.js'
+import { addMCPPrompt } from './add-mcp-prompt.js'
 import { InspectorFilters, InspectorState } from './types.js'
 import { addFunctions } from './add-functions.js'
 import { addChannel } from './add-channel.js'
@@ -62,6 +66,10 @@ export const visitRoutes = (
 ) => {
   addHTTPRoute(node, checker, state, filters)
   addSchedule(node, checker, state, filters)
+  addQueueWorker(node, checker, state, filters)
   addChannel(node, checker, state, filters)
+  addMCPResource(node, checker, state, filters)
+  addMCPTool(node, checker, state, filters)
+  addMCPPrompt(node, checker, state, filters)
   ts.forEachChild(node, (child) => visitRoutes(checker, child, state, filters))
 }

package/tsconfig.json

@@ -2,7 +2,7 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "rootDir": "./src",
-    "module": "Node16",
+    "module": "Node18",
     "outDir": "dist",
     "target": "esnext",
     "declaration": true,