Skip to main content
Glama
interfaces.ts1.85 kB
/** * Interface for document management operations exposed externally. * Implemented by the local DocumentManagementService and the remote tRPC client. */ import type { ScraperOptions } from "../../scraper/types"; import type { EmbeddingModelConfig } from "../embeddings/EmbeddingConfig"; import type { DbVersionWithLibrary, FindVersionResult, LibrarySummary, StoredScraperOptions, StoreSearchResult, VersionStatus, } from "../types"; export interface IDocumentManagement { // Lifecycle initialize(): Promise<void>; shutdown(): Promise<void>; // Library/version introspection used by tools/UI listLibraries(): Promise<LibrarySummary[]>; validateLibraryExists(library: string): Promise<void>; findBestVersion(library: string, targetVersion?: string): Promise<FindVersionResult>; // Search & mutation used by tools/UI searchStore( library: string, version: string | null | undefined, query: string, limit?: number, ): Promise<StoreSearchResult[]>; removeAllDocuments(library: string, version?: string | null): Promise<void>; removeVersion(library: string, version?: string | null): Promise<void>; // Minimal set used indirectly by pipeline/UI where needed getVersionsByStatus(statuses: VersionStatus[]): Promise<DbVersionWithLibrary[]>; findVersionsBySourceUrl(url: string): Promise<DbVersionWithLibrary[]>; getScraperOptions(versionId: number): Promise<StoredScraperOptions | null>; updateVersionStatus( versionId: number, status: VersionStatus, errorMessage?: string, ): Promise<void>; updateVersionProgress( versionId: number, pages: number, maxPages: number, ): Promise<void>; storeScraperOptions(versionId: number, options: ScraperOptions): Promise<void>; // Embedding configuration getActiveEmbeddingConfig(): EmbeddingModelConfig | null; }

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/arabold/docs-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server