AI assistant grounded in your docs.
Any LLM provider. Your keys never leave your server.

import { DocmdAssistantEngine } from 'docmd-assistant';
import * as Search from '@docmd/plugin-search/client';

// 1. Initialise engine instance with provider configuration
const engine = new DocmdAssistantEngine({
  provider: 'openai',
  model: 'gpt-4o-mini',
  systemPrompt: 'You are a helpful software documentation assistant.',
  ragCallback: async (query) => {
    const matches = await Search.search(query, 5);
    return matches.map(m => m.chunk.text).join('\\n\\n');
  }
});

// 2. Register custom client-side execution tool
engine.registerTool({
  name: 'fetch_user_workspace',
  description: 'Retrieve active workspace configuration',
  parameters: { type: 'object', properties: { workspaceId: { type: 'string' } } },
  handler: async ({ workspaceId }) => ({ activeTheme: 'summer', mode: 'spa' })
});

// 3. Listen to real-time stream events and execute query turn
engine.on('token', (chunk) => process.stdout.write(chunk));
await engine.sendMessage('How do I set up custom navigation in docmd?');