expose mcp server in ontime

2026-08-20 14:39:06 +00:00 · 2026-07-01 12:48:40 +02:00
parent ce8a4d230b
commit 48f9fb2609
19 changed files with 2291 additions and 77 deletions
@@ -0,0 +1,87 @@
+import type { ListResourcesResult, ReadResourceResult } from '@modelcontextprotocol/sdk/types.js';
+
+import { getProjectData } from '../api-data/project-data/projectData.dao.js';
+import { getCurrentRundown, getProjectCustomFields } from '../api-data/rundown/rundown.dao.js';
+import { normalisedToRundownArray } from '../api-data/rundown/rundown.utils.js';
+import { getDataProvider } from '../classes/data-provider/DataProvider.js';
+import { ONTIME_DOCS_MARKDOWN, ONTIME_SCHEMA_MARKDOWN } from './mcp.schema.js';
+
+export const RESOURCE_DEFINITIONS: ListResourcesResult['resources'] = [
+  {
+    uri: 'ontime://schema',
+    name: 'ontime-schema',
+    title: 'Ontime data model reference',
+    description:
+      'Markdown reference for rundown structure, event fields, time format, and entry types. Read once per session to ground tool calls in the correct data model.',
+    mimeType: 'text/markdown',
+  },
+  {
+    uri: 'ontime://rundown/current',
+    name: 'current-rundown',
+    title: 'Currently loaded rundown',
+    description:
+      'The rundown currently active in Ontime, with its full entries map and order. Re-read after any mutating call to see updated state.',
+    mimeType: 'application/json',
+  },
+  {
+    uri: 'ontime://rundowns',
+    name: 'project-rundowns',
+    title: 'All rundowns in the project',
+    description: 'List of every rundown stored in the current project file, plus the ID of the one currently loaded.',
+    mimeType: 'application/json',
+  },
+  {
+    uri: 'ontime://project/info',
+    name: 'project-info',
+    title: 'Project metadata',
+    description: 'Project title, description, URL, info, logo, and custom header fields.',
+    mimeType: 'application/json',
+  },
+  {
+    uri: 'ontime://project/custom-fields',
+    name: 'project-custom-fields',
+    title: 'Custom field definitions',
+    description:
+      'Map of custom field keys to their label, type, and colour. Events reference these keys in their `custom` object.',
+    mimeType: 'application/json',
+  },
+  {
+    uri: 'ontime://docs',
+    name: 'ontime-docs',
+    title: 'Ontime documentation index',
+    description:
+      'Curated index of Ontime documentation topics with direct links to https://docs.getontime.no. Read this when you need to understand a concept in more depth or want to point the user to official documentation.',
+    mimeType: 'text/markdown',
+  },
+];
+
+const RESOURCE_READERS: Record<string, { mimeType: string; read: () => string }> = {
+  'ontime://schema': { mimeType: 'text/markdown', read: () => ONTIME_SCHEMA_MARKDOWN },
+  'ontime://docs': { mimeType: 'text/markdown', read: () => ONTIME_DOCS_MARKDOWN },
+  'ontime://rundown/current': {
+    mimeType: 'application/json',
+    read: () => JSON.stringify(getCurrentRundown()),
+  },
+  'ontime://rundowns': {
+    mimeType: 'application/json',
+    read: () => {
+      const rundowns = normalisedToRundownArray(getDataProvider().getProjectRundowns());
+      const loaded = getCurrentRundown().id;
+      return JSON.stringify({ loaded, rundowns });
+    },
+  },
+  'ontime://project/info': {
+    mimeType: 'application/json',
+    read: () => JSON.stringify(getProjectData()),
+  },
+  'ontime://project/custom-fields': {
+    mimeType: 'application/json',
+    read: () => JSON.stringify(getProjectCustomFields()),
+  },
+};
+
+export function handleReadResource(uri: string): ReadResourceResult {
+  const reader = RESOURCE_READERS[uri];
+  if (!reader) throw new Error(`Unknown resource URI: ${uri}`);
+  return { contents: [{ uri, mimeType: reader.mimeType, text: reader.read() }] };
+}