@grafana/assistant 0.1.9 → 0.1.11

package/README.md

@@ -36,7 +36,7 @@ function MyComponent() {
   }
 
   return (
-    <button onClick={() => openAssistant({ 
+    <button onClick={() => openAssistant({
       origin: 'grafana/panel-data-analyzer',
       prompt: 'Help me analyze data' })}>
       Open Assistant
@@ -54,7 +54,11 @@ import { openAssistant, closeAssistant } from '@grafana/assistant';
 openAssistant({ origin: 'grafana/some-feature', prompt: 'Show me CPU usage over the last hour' });
 
 // Open the assistant with initial prompt and autoSend set to false
-openAssistant({ origin: 'grafana-datasources/prometheus/some-feature', prompt: 'Help me analyze data', autoSend: false })
+openAssistant({
+  origin: 'grafana-datasources/prometheus/some-feature',
+  prompt: 'Help me analyze data',
+  autoSend: false,
+});
 
 // Open the assistant without an initial prompt
 openAssistant({
@@ -79,14 +83,14 @@ const dashboardContext = createAssistantContextItem('dashboard', {
   dashboardUid: 'dashboard-uid',
   dashboardTitle: 'System Overview',
   folderUid: 'folder-uid',
-  folderTitle: 'Production'
+  folderTitle: 'Production',
 });
 
 // Open the assistant with initial prompt and context
-openAssistant({ 
+openAssistant({
   origin: 'grafana/dashboard-page',
   prompt: 'Analyze the CPU metrics from this dashboard',
-  context: [datasourceContext, dashboardContext]
+  context: [datasourceContext, dashboardContext],
 });
 
 // Create hidden context for system instructions (won't show in UI pills)
@@ -95,14 +99,14 @@ const systemInstructions = createAssistantContextItem('structured', {
   title: 'System Instructions',
   data: {
     instructions: 'When analyzing metrics, always consider seasonal patterns and anomalies',
-    preferences: 'Use clear, technical language and provide actionable insights'
-  }
+    preferences: 'Use clear, technical language and provide actionable insights',
+  },
 });
 
 // Include hidden context with visible context
-openAssistant({ 
+openAssistant({
   prompt: 'What are the trends in this data?',
-  context: [datasourceContext, systemInstructions]
+  context: [datasourceContext, systemInstructions],
 });
 ```
 
@@ -119,8 +123,8 @@ const dashboardContext = createAssistantContextItem('structured', {
     name: 'Dashboard Context',
     pageType: 'dashboard',
     capabilities: ['view', 'edit', 'share'],
-    help: 'Use the assistant to analyze dashboard data, create queries, or troubleshoot issues.'
-  }
+    help: 'Use the assistant to analyze dashboard data, create queries, or troubleshoot issues.',
+  },
 });
 
 // Register context for all dashboard pages and get a setter function
@@ -133,9 +137,9 @@ setContext([
     data: {
       name: 'Panel Context',
       selectedPanel: 'cpu-usage-panel',
-      panelType: 'graph'
-    }
-  })
+      panelType: 'graph',
+    },
+  }),
 ]);
 
 // Clean up when no longer needed
@@ -147,7 +151,8 @@ providePageContext('/explore', [
     hidden: true,
     title: 'Additional instructions',
     data: {
-      'System Instructions': 'When working with explore queries, always validate the time range and check for data availability. Suggest using recording rules for expensive queries.',
+      'System Instructions':
+        'When working with explore queries, always validate the time range and check for data availability. Suggest using recording rules for expensive queries.',
     },
   }),
 ]);
@@ -197,9 +202,9 @@ import { usePageContext } from '@grafana/assistant';
 
 function MyComponent() {
   const pageContext = usePageContext();
-  
+
   console.log('Active context items:', pageContext);
-  
+
   return <div>Page has {pageContext.length} context items</div>;
 }
 ```
@@ -215,7 +220,7 @@ import { createAssistantContextItem } from '@grafana/assistant';
 const datasourceContext = createAssistantContextItem('datasource', {
   datasourceUid: 'prom-123',
   title: 'Main Datasource', // Optional custom title
-  icon: 'database' // Optional custom icon
+  icon: 'database', // Optional custom icon
 });
 
 // Create a dashboard context
@@ -223,14 +228,14 @@ const dashboardContext = createAssistantContextItem('dashboard', {
   dashboardUid: 'dash-456',
   dashboardTitle: 'Application Overview',
   folderUid: 'folder-789',
-  folderTitle: 'Production Dashboards'
+  folderTitle: 'Production Dashboards',
 });
 
 // Create a label context
 const labelContext = createAssistantContextItem('label_name', {
   datasourceUid: 'prom-123',
   datasourceType: 'prometheus',
-  labelName: 'service'
+  labelName: 'service',
 });
 
 // Create a label value context
@@ -238,13 +243,13 @@ const labelValueContext = createAssistantContextItem('label_value', {
   datasourceUid: 'prom-123',
   datasourceType: 'prometheus',
   labelName: 'service',
-  labelValue: 'api-server'
+  labelValue: 'api-server',
 });
 
 // Create a folder context
 const folderContext = createAssistantContextItem('dashboard_folder', {
   folderUid: 'folder-789',
-  folderTitle: 'Production Dashboards'
+  folderTitle: 'Production Dashboards',
 });
 
 // Create structured data context
@@ -252,14 +257,14 @@ const structuredContext = createAssistantContextItem('structured', {
   data: {
     name: 'Custom Data',
     metrics: ['cpu_usage', 'memory_usage'],
-    threshold: 80
-  }
+    threshold: 80,
+  },
 });
 
 // Create generic context
 const genericContext = createAssistantContextItem('unknown', {
   id: 'my-context',
-  text: 'Some additional context information'
+  text: 'Some additional context information',
 });
 
 // Create component context for custom React components
@@ -278,12 +283,12 @@ const componentContext = createAssistantContextItem('component', {
 
 // Create hidden context (useful for system instructions)
 const hiddenInstructions = createAssistantContextItem('structured', {
-  hidden: true,  // Won't be shown in UI pills but will be sent to the assistant
+  hidden: true, // Won't be shown in UI pills but will be sent to the assistant
   title: 'Page-specific instructions',
   data: {
     instructions: 'Always provide step-by-step explanations',
-    context: 'This is a complex system with multiple dependencies'
-  }
+    context: 'This is a complex system with multiple dependencies',
+  },
 });
 ```
 
@@ -357,6 +362,7 @@ export function configureAssistantContext() {
 - **No Code Blocks**: Custom components should never be wrapped in markdown code blocks
 
 **Example Component Implementation:**
+
 ```typescript
 interface MyEntityMentionProps {
   name: string;
@@ -369,8 +375,8 @@ interface MyEntityMentionProps {
 
 const MyEntityMention: React.FC<MyEntityMentionProps> = ({ name, type, env, site, namespace, properties }) => {
   return (
-    <span 
-      className="entity-mention" 
+    <span
+      className="entity-mention"
       data-entity-type={type}
       title={`${type}: ${name}`}
     >
@@ -402,14 +408,14 @@ providePageContext('/explore', [
       instructions: [
         'Always validate time ranges before running queries',
         'Suggest using recording rules for expensive queries',
-        'Warn about queries that might impact performance'
+        'Warn about queries that might impact performance',
       ],
       queryLimits: {
         maxTimeRange: '24h',
-        suggestedSampleInterval: '1m'
-      }
-    }
-  })
+        suggestedSampleInterval: '1m',
+      },
+    },
+  }),
 ]);
 
 // Add dashboard-specific context
@@ -419,21 +425,21 @@ providePageContext('/d/*', [
     title: 'Dashboard Instructions',
     data: {
       bestPractices: 'Encourage users to use template variables for flexibility',
-      performance: 'Suggest panel caching for slow queries'
-    }
-  })
+      performance: 'Suggest panel caching for slow queries',
+    },
+  }),
 ]);
 ```
 
 ### Exposing Functions to the Assistant
 
 ```typescript
-import { 
-  getExposeAssistantFunctionsConfig, 
+import {
+  getExposeAssistantFunctionsConfig,
   newFunctionNamespace,
   FunctionImplementation,
   FunctionNamespace,
-  NamedFunctions 
+  NamedFunctions,
 } from '@grafana/assistant';
 
 // Define your functions
@@ -441,19 +447,17 @@ const myFunctions: NamedFunctions = {
   getMetrics: (datasource: string) => {
     return ['cpu_usage', 'memory_usage', 'disk_io'];
   },
-  
+
   calculateAverage: (values: number[]) => {
     return values.reduce((a, b) => a + b, 0) / values.length;
-  }
+  },
 };
 
 // Create a namespace for your functions
 const namespace = newFunctionNamespace('myPlugin', myFunctions);
 
 // Export the configuration for your plugin
-export const getExtensionConfigs = () => [
-  getExposeAssistantFunctionsConfig([namespace])
-];
+export const getExtensionConfigs = () => [getExposeAssistantFunctionsConfig([namespace])];
 ```
 
 ### Using the OpenAssistantButton Component
@@ -472,14 +476,14 @@ function MyDashboard() {
   return (
     <div>
       <h1>Dashboard</h1>
-      
+
       {/* Basic usage */}
       <OpenAssistantButton
         prompt="Help me analyze the CPU usage trends in this dashboard"
         context={[dashboardContext]}
         origin="grafana/dashboard-menu"
       />
-      
+
       {/* Icon-only button */}
       <OpenAssistantButton
         prompt="Show me optimization suggestions"
@@ -488,7 +492,7 @@ function MyDashboard() {
         size="md"
         origin="grafana-datasources/loki/query-editor"
       />
-      
+
       {/* Button without auto-send */}
       <OpenAssistantButton
         prompt="What patterns do you see in the data?"
@@ -511,20 +515,80 @@ function MyDashboard() {
 A React hook that provides assistant availability status and control functions.
 
 **Returns:** An object with the following properties:
+
 - `isAvailable: boolean` - Whether the Assistant is available
 - `openAssistant?: (props: OpenAssistantProps) => void` - Function to open the assistant (undefined if not available)
 - `closeAssistant?: () => void` - Function to close the assistant (undefined if not available)
 - `toggleAssistant?: (props: OpenAssistantProps) => void` - Function to toggle the assistant (undefined if not available)
 
-#### `useTerms(): { accepted: boolean; loading: boolean; error: string | null; acceptTerms: () => Promise<void> }`
+#### `useTerms(): { accepted: boolean; loading: boolean; error: string | null }`
 
 A React hook to check terms and conditions acceptance status. Automatically fetches terms data on mount and provides loading/error states.
 
 **Returns:** An object with the following properties:
+
 - `accepted: boolean` - Whether terms are accepted and up-to-date
 - `loading: boolean` - Whether the check is in progress
 - `error: string | null` - Error message if the check failed, null otherwise
-- `acceptTerms: () => Promise<void>` - Function to accept the current terms and conditions
+
+#### `useLimits(): LimitsHookResult`
+
+A React hook to check user prompt limits. Automatically fetches limits data on mount and listens to real-time updates via custom events when the Assistant plugin updates limits.
+
+**Returns:** An object with the following properties:
+
+- `count: number` - Current prompt count for the month
+- `limit: number` - Monthly prompt limit (0 = unlimited)
+- `month: string` - Current month in YYYY-MM format
+- `isLimitReached: boolean` - Whether the limit has been reached
+- `loading: boolean` - Whether the initial fetch is in progress
+- `error: string | null` - Error message if the fetch failed, null otherwise
+- `refetch: () => void` - Function to manually refetch limits
+
+**Example:**
+
+```typescript
+import { useLimits } from '@grafana/assistant';
+
+function MyComponent() {
+  const { count, limit, isLimitReached, loading, error } = useLimits();
+
+  if (loading) return <div>Loading...</div>;
+  if (error) return <div>Error: {error}</div>;
+  if (isLimitReached) {
+    return <div>Monthly limit reached ({count}/{limit})</div>;
+  }
+  return <div>Prompts used: {count}/{limit || 'unlimited'}</div>;
+}
+```
+
+#### `checkLimits(): Promise<LimitsData>`
+
+An async function to check user prompt limits. Returns a promise with the limits data.
+
+**Returns:** A promise that resolves to an object with:
+
+- `count: number` - Current prompt count for the month
+- `limit: number` - Monthly prompt limit (0 = unlimited)
+- `month: string` - Current month in YYYY-MM format
+- `isLimitReached: boolean` - Whether the limit has been reached
+
+**Example:**
+
+```typescript
+import { checkLimits } from '@grafana/assistant';
+
+async function checkUserLimits() {
+  try {
+    const { isLimitReached, count, limit } = await checkLimits();
+    if (isLimitReached) {
+      console.log(`Limit reached: ${count}/${limit}`);
+    }
+  } catch (error) {
+    console.error('Failed to check limits:', error);
+  }
+}
+```
 
 #### `usePageContext(): ChatContextItem[]`
 
@@ -537,6 +601,7 @@ A React hook that returns all active context items for the current page based on
 A React hook for providing page context that automatically cleans up on unmount. This is the recommended way to use page context in React components.
 
 **Parameters:**
+
 - `urlPattern` - URL pattern (string or RegExp) to match against page URLs
 - `initialContext` - Initial array of ChatContextItem to provide when the pattern matches (defaults to empty array)
 
@@ -549,15 +614,16 @@ A React hook that provides all components available for the current page. This h
 **Returns:** Object containing all components available for the current page, keyed by `namespace_componentName` format.
 
 **Example:**
+
 ```typescript
 import { usePageComponents } from '@grafana/assistant';
 
 function MyAssistantComponent() {
   const components = usePageComponents();
-  
+
   // Access components registered with namespace 'myapp' and component name 'EntityMention'
   const EntityMentionComponent = components['myapp_EntityMention'];
-  
+
   return (
     <div>
       Available components: {Object.keys(components).join(', ')}
@@ -573,8 +639,9 @@ function MyAssistantComponent() {
 A pre-built React component that renders a button to open the Grafana Assistant with configurable prompt and context.
 
 **Parameters:**
+
 - `prompt: string` - **Required** The initial prompt to display in the assistant
-- `origin: string` - **Required**  Origin of the request that opened the assistant. Should be structured using forward slashes with the first part as a namespace. Examples: 'grafana-datasources/prometheus/query-builder', 'grafana-slo-app/slo-editor-overview'
+- `origin: string` - **Required** Origin of the request that opened the assistant. Should be structured using forward slashes with the first part as a namespace. Examples: 'grafana-datasources/prometheus/query-builder', 'grafana-slo-app/slo-editor-overview'
 - `context?: ChatContextItem[]` - Optional context items created with `createAssistantContextItem`
 - `autoSend?: boolean` - Whether to automatically send the initial prompt (defaults to `true`)
 - `title?: string` - Text to display on the button (defaults to `'Analyze with Assistant'`)
@@ -706,6 +773,7 @@ export function PanelEditor() {
 ```
 
 **Key Features:**
+
 - `isGenerating` - Boolean indicating generation is in progress
 - `content` - Current streaming content (updates in real-time)
 - `generate(options)` - Start a new generation
@@ -738,7 +806,7 @@ export const createWeatherTool = (onToolComplete: (data: WeatherData) => void) =
   return createTool(
     async (input: z.infer<typeof weatherSchema>): Promise<ToolOutput> => {
       const { city } = input;
-      
+
       // Fetch weather data (simplified example)
       const weatherData: WeatherData = {
         city,
@@ -746,10 +814,10 @@ export const createWeatherTool = (onToolComplete: (data: WeatherData) => void) =
         conditions: 'Sunny',
         humidity: 65,
       };
-      
+
       // Call the callback to pass artifact data
       onToolComplete(weatherData);
-      
+
       // Return tuple: [text response, artifact]
       return [
         `Current weather in ${city}: ${weatherData.temperature.celsius}°C, ${weatherData.conditions}`,
@@ -794,6 +862,43 @@ export function WeatherComponent() {
 }
 ```
 
+### Investigation Events
+
+Subscribe to investigation lifecycle events to react when investigations are created.
+
+#### `onInvestigationCreated(callback: (payload: InvestigationCreatedPayload) => void): () => void`
+
+Subscribe to investigation created events.
+
+**Parameters:**
+
+- `callback` - Function called when an investigation is created, receives `{ investigationId: string }`
+
+**Returns:** An unsubscribe function to stop listening for events
+
+**Example:**
+
+```typescript
+import { onInvestigationCreated } from '@grafana/assistant';
+
+// Subscribe to investigation creation events
+const unsubscribe = onInvestigationCreated((payload) => {
+  console.log('Investigation created:', payload.investigationId);
+  // Navigate to the investigation, update UI, etc.
+});
+
+// Later, when you want to stop listening
+unsubscribe();
+```
+
+#### `emitInvestigationCreated(investigationId: string): void`
+
+Emit an investigation created event. This is typically used internally by the Assistant but can be called by external integrations if needed.
+
+**Parameters:**
+
+- `investigationId` - The ID of the newly created investigation
+
 ### Availability Functions
 
 #### `isAssistantAvailable(): Observable<boolean>`
@@ -804,9 +909,12 @@ Checks if the assistant plugin is available.
 
 ### Terms and Conditions Functions
 
+> **Note:** In most cases, plugins do not need to check terms directly. The Grafana Assistant automatically handles cases when terms are not accepted by prompting the user to accept them before proceeding.
+
 #### `checkTerms(): Promise<boolean>`
 
 Checks whether terms and conditions are accepted and up-to-date. This function verifies that:
+
 1. Terms have been accepted
 2. The accepted version matches or exceeds the current version
 
@@ -815,6 +923,7 @@ Checks whether terms and conditions are accepted and up-to-date. This function v
 **Throws:** Error if the API call fails.
 
 **Example:**
+
 ```typescript
 import { checkTerms } from '@grafana/assistant';
 
@@ -829,52 +938,6 @@ try {
 }
 ```
 
-#### `acceptTerms(): Promise<void>`
-
-Accepts terms and conditions for the current tenant. This function sends a PUT request to mark the current terms version as accepted.
-
-**Returns:** A promise that resolves when terms are successfully accepted.
-
-**Throws:** Error if the API call fails.
-
-**Example:**
-
-```typescript
-import { acceptTerms } from '@grafana/assistant';
-
-try {
-  await acceptTerms();
-  console.log('Terms accepted successfully');
-} catch (error) {
-  // Handle error
-  console.error('Failed to accept terms:', error);
-}
-```
-
-**Example with `useTerms` hook:**
-
-```typescript
-import { useTerms } from '@grafana/assistant';
-
-function TermsComponent() {
-  const { accepted, loading, error, acceptTerms } = useTerms();
-
-  if (loading) return <div>Loading...</div>;
-  if (error) return <div>Error: {error}</div>;
-  
-  if (!accepted) {
-    return (
-      <div>
-        <p>Please accept the terms and conditions</p>
-        <button onClick={() => acceptTerms()}>Accept Terms</button>
-      </div>
-    );
-  }
-  
-  return <div>Terms accepted</div>;
-}
-```
-
 ### Sidebar Functions
 
 #### `openAssistant(props: OpenAssistantProps): void`
@@ -882,6 +945,7 @@ function TermsComponent() {
 Opens the Grafana Assistant sidebar.
 
 **Parameters:**
+
 - `props: OpenAssistantProps` - Configuration object
   - `origin: string` - Origin of the request that opened the assistant. Should be structured using forward slashes with the first part as a namespace. Examples: 'grafana-datasources/prometheus/query-builder', 'grafana-slo-app/slo-editor-overview'
   - `prompt?: string` - Optional initial prompt to display in the assistant
@@ -899,9 +963,10 @@ Closes the Grafana Assistant sidebar.
 Creates a context item that can be passed to the assistant to provide additional information.
 
 **Parameters:**
+
 - `type` - The type of context to create. Supported types:
   - `'datasource'` - Datasource context
-  - `'dashboard'` - Dashboard context  
+  - `'dashboard'` - Dashboard context
   - `'dashboard_folder'` - Folder context
   - `'label_name'` - Label name context
   - `'label_value'` - Label value context
@@ -918,6 +983,7 @@ Creates a context item that can be passed to the assistant to provide additional
 Registers context items for specific pages based on URL patterns. Returns a setter function to update the context dynamically. The context will be automatically included when the assistant is opened on pages matching the pattern.
 
 **Parameters:**
+
 - `urlPattern` - URL pattern (string with wildcards or RegExp) to match against page URLs
   - String patterns support `*` (match any characters) and `**` (match any path segments)
   - RegExp patterns provide full regex matching capabilities
@@ -926,12 +992,13 @@ Registers context items for specific pages based on URL patterns. Returns a sett
 **Returns:** A setter function to update the context, with an `unregister` method attached for cleanup
 
 **Examples:**
+
 ```typescript
 // String patterns - returns setter function
 const setDashboardContext = providePageContext('/d/*', initialContext); // Match any dashboard
 const setExploreContext = providePageContext('/explore**', initialContext); // Match explore and subpaths
 
-// RegExp patterns  
+// RegExp patterns
 const setSpecificContext = providePageContext(/^\/d\/[a-zA-Z0-9]+$/, initialContext); // Match specific dashboard format
 
 // Update context dynamically
@@ -946,6 +1013,7 @@ setDashboardContext.unregister();
 A simplified function for providing components to the assistant. This is a convenience wrapper around `providePageContext` specifically for registering components.
 
 **Parameters:**
+
 - `prompt` - Instructions for the assistant on how and when to use these components
 - `namespace` - A unique identifier for your app's components (e.g., 'myapp', 'datasource')
 - `components` - A record of component names to their React component implementations
@@ -954,6 +1022,7 @@ A simplified function for providing components to the assistant. This is a conve
 **Returns:** A setter function to update the context, with an `unregister` method attached for cleanup
 
 **Example:**
+
 ```typescript
 import { provideComponents } from '@grafana/assistant';
 import MyEntityMention from './components/MyEntityMention';
@@ -994,27 +1063,29 @@ The questions system allows external parties to provide sample prompts with opti
 Registers questions for specific pages based on URL patterns. Returns a setter function to update the questions dynamically.
 
 **Parameters:**
+
 - `urlPattern` - URL pattern (string with wildcards or RegExp) to match against page URLs
 - `initialQuestions` - Initial array of `Question` to provide when the pattern matches
 
 **Returns:** A setter function to update the questions, with an `unregister` method attached for cleanup
 
 **Examples:**
+
 ```typescript
 // Register questions for dashboard pages
-const setQuestions = provideQuestions("/d/*", [
+const setQuestions = provideQuestions('/d/*', [
   {
-    prompt: "What metrics are available in this dashboard?",
+    prompt: 'What metrics are available in this dashboard?',
     context: [], // Optional context items created with `createAssistantContextItem`
   },
   {
-    prompt: "How can I optimize the queries in this dashboard?",
+    prompt: 'How can I optimize the queries in this dashboard?',
     context: [
-      createAssistantContextItem("dashboard", {
+      createAssistantContextItem('dashboard', {
         dashboardUid: 'dashboard-uid',
         dashboardTitle: 'System Overview',
         folderUid: 'folder-uid',
-        folderTitle: 'Production'
+        folderTitle: 'Production',
       }),
     ],
   },
@@ -1023,9 +1094,9 @@ const setQuestions = provideQuestions("/d/*", [
 // Update questions dynamically
 setQuestions([
   {
-    prompt: "What are the key insights from this dashboard?",
-    context: []
-  }
+    prompt: 'What are the key insights from this dashboard?',
+    context: [],
+  },
 ]);
 
 // Cleanup when done
@@ -1037,12 +1108,14 @@ setQuestions.unregister();
 React hook for providing questions that automatically cleans up on unmount. This is the recommended way to use questions in React components.
 
 **Parameters:**
+
 - `urlPattern` - URL pattern (string or RegExp) to match against page URLs
 - `initialQuestions` - Initial array of questions to provide when the pattern matches (defaults to empty array)
 
 **Returns:** A setter function to update the questions
 
 **Example:**
+
 ```typescript
 function DashboardComponent() {
   const setQuestions = useProvideQuestions('/d/*', [
@@ -1065,10 +1138,11 @@ React hook to get all questions that match the current URL. This filters the pag
 **Returns:** Array of questions from all matching registrations
 
 **Example:**
+
 ```typescript
 function AssistantComponent() {
   const questions = useQuestions();
-  
+
   return (
     <div>
       <h3>Suggested Questions:</h3>
@@ -1134,7 +1208,7 @@ Represents a registered page context mapping.
 
 ```typescript
 interface Question {
-  prompt: string;           // The sample prompt/question
+  prompt: string; // The sample prompt/question
   context?: ChatContextItem[]; // Optional context items
 }
 ```
@@ -1162,7 +1236,7 @@ interface CreateDatasourceContextParams {
   datasourceUid: string;
   title?: string;
   icon?: IconName;
-  hidden?: boolean;  // If true, the context item will not be shown in the context pills
+  hidden?: boolean; // If true, the context item will not be shown in the context pills
 }
 ```
 
@@ -1176,7 +1250,7 @@ interface CreateDashboardContextParams {
   folderTitle?: string;
   title?: string;
   icon?: IconName;
-  hidden?: boolean;  // If true, the context item will not be shown in the context pills
+  hidden?: boolean; // If true, the context item will not be shown in the context pills
 }
 ```
 
@@ -1188,7 +1262,7 @@ interface CreateFolderContextParams {
   folderTitle: string;
   title?: string;
   icon?: IconName;
-  hidden?: boolean;  // If true, the context item will not be shown in the context pills
+  hidden?: boolean; // If true, the context item will not be shown in the context pills
 }
 ```
 
@@ -1201,7 +1275,7 @@ interface CreateLabelNameContextParams {
   labelName: string;
   title?: string;
   icon?: IconName;
-  hidden?: boolean;  // If true, the context item will not be shown in the context pills
+  hidden?: boolean; // If true, the context item will not be shown in the context pills
 }
 ```
 
@@ -1215,7 +1289,7 @@ interface CreateLabelValueContextParams {
   labelValue: string;
   title?: string;
   icon?: IconName;
-  hidden?: boolean;  // If true, the context item will not be shown in the context pills
+  hidden?: boolean; // If true, the context item will not be shown in the context pills
 }
 ```
 
@@ -1226,7 +1300,7 @@ interface StructuredNodeDataParams {
   data: Record<string, any>;
   title?: string;
   icon?: IconName;
-  hidden?: boolean;  // If true, the context item will not be shown in the context pills
+  hidden?: boolean; // If true, the context item will not be shown in the context pills
 }
 ```
 
@@ -1236,10 +1310,10 @@ interface StructuredNodeDataParams {
 interface CreateComponentContextParams {
   components: Record<string, React.ComponentType<any>>;
   prompt: string;
-  namespace?: string;  // Optional: defaults to 'components' if not provided
+  namespace?: string; // Optional: defaults to 'components' if not provided
   title?: string;
   icon?: IconName;
-  hidden?: boolean;  // If true, the context item will not be shown in the context pills
+  hidden?: boolean; // If true, the context item will not be shown in the context pills
 }
 ```
 
@@ -1251,7 +1325,7 @@ interface NodeDataParams {
   text?: string;
   title?: string;
   icon?: IconName;
-  hidden?: boolean;  // If true, the context item will not be shown in the context pills
+  hidden?: boolean; // If true, the context item will not be shown in the context pills
 }
 ```
 
@@ -1299,6 +1373,7 @@ Groups functions under a namespace.
 Creates a new function namespace.
 
 **Parameters:**
+
 - `namespace: string` - The namespace identifier
 - `functions: NamedFunctions` - The functions to include in the namespace
 
@@ -1307,6 +1382,7 @@ Creates a new function namespace.
 Creates a plugin extension configuration for exposing functions to the assistant.
 
 **Parameters:**
+
 - `namespaces: FunctionNamespace[]` - Array of function namespaces to expose
 
 ### Constants
@@ -1326,7 +1402,7 @@ The package also exports the following types for advanced use cases:
 ```typescript
 // Data types for context items
 export type DashboardNodeData;
-export type DatasourceNodeData; 
+export type DatasourceNodeData;
 export type FolderNodeData;
 export type LabelNameNodeData;
 export type LabelValueNodeData;
@@ -1341,4 +1417,4 @@ export type NamedComponents;
 
 ## License
 
-Apache-2.0
+Apache-2.0