Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
| 1 | export type KbFreshness = 'evergreen' | 'time-sensitive'; |
| 2 | export type KbPublicationState = 'published' | 'needs-review' | 'retired'; |
| 3 | |
| 4 | export interface KbSourceMetadata { |
| 5 | type: string; |
| 6 | title: string; |
| 7 | description: string; |
| 8 | category: string; |
| 9 | visibility: string; |
| 10 | timestamp: string; |
| 11 | tags: string[]; |
| 12 | } |
| 13 | |
| 14 | export interface KbSourceDocument { |
| 15 | metadata: KbSourceMetadata; |
| 16 | body: string; |
| 17 | } |
| 18 | |
| 19 | export interface KbTopic { |
| 20 | slug: string; |
| 21 | title: string; |
| 22 | description: string; |
| 23 | featuredRank: number | null; |
| 24 | } |
| 25 | |
| 26 | export interface KbSourceReference { |
| 27 | sourcePath: string; |
| 28 | sourceHeading: string | null; |
| 29 | } |
| 30 | |
| 31 | export interface KbGuideDefinition { |
| 32 | /** Portal approvals own this guide across upstream refreshes. */ |
| 33 | managedBy?: 'support-portal'; |
| 34 | slug: string; |
| 35 | title: string; |
| 36 | description: string; |
| 37 | articlePath?: string; |
| 38 | sources: KbSourceReference[]; |
| 39 | topics: string[]; |
| 40 | tags: string[]; |
| 41 | aliases: string[]; |
| 42 | relatedGuides: string[]; |
| 43 | externalResources: string[]; |
| 44 | updatedAt: string; |
| 45 | lastVerifiedAt: string | null; |
| 46 | reviewAfter: string | null; |
| 47 | freshness: KbFreshness; |
| 48 | state: KbPublicationState; |
| 49 | featured: boolean; |
| 50 | /** |
| 51 | * Tool slugs this guide may cite even though they are absent from the production |
| 52 | * catalog — for guides whose subject is that an identifier was removed or renamed. |
| 53 | * Declared here so `verify:kb` exemptions are reviewable rather than silent. |
| 54 | */ |
| 55 | verifyIgnoreToolSlugs?: string[]; |
| 56 | } |
| 57 | |
| 58 | export interface KbGuide extends KbGuideDefinition { |
| 59 | body: string; |
| 60 | sourceMetadata: KbSourceMetadata[]; |
| 61 | } |
| 62 | |
| 63 | export interface KbManifest { |
| 64 | schemaVersion: 2; |
| 65 | topics: KbTopic[]; |
| 66 | guides: KbGuideDefinition[]; |
| 67 | } |
| 68 | |
| 69 | export interface KbCatalog { |
| 70 | manifest: KbManifest; |
| 71 | topics: KbTopic[]; |
| 72 | guides: KbGuide[]; |
| 73 | } |