create_knowledge_file
Generate structured knowledge documents with metadata and chapters for technical topics, APIs, reference guides, and troubleshooting. Supports search, chapter organization, and filename sanitization for efficient knowledge management.
Instructions
Create a structured knowledge document with rich metadata and chapters.
When to use this tool:
Documenting specific technical topics or APIs
Creating reference guides for project components
Building troubleshooting or how-to guides
Organizing domain-specific knowledge
Archiving important technical decisions
Key features:
Structured with chapters for easy navigation
Searchable via keywords
Automatic filename sanitization (spaces→hyphens)
Metadata for context and discovery
Supports up to 50 chapters per document
You should:
Search first to avoid creating duplicates
Choose descriptive, specific filenames
Include 3-5 relevant keywords minimum
Structure content into logical chapters
Write clear chapter titles (max 200 chars)
Include practical examples in content
Add .md extension to filename
Keep chapters focused and concise
Consider future searchability
DO NOT use when:
Content belongs in main.md
Document already exists (search first!)
Information is temporary or transient
Creating index/navigation files
Chapters require 'title' and 'content' keys Returns: {success: bool, document_id?: str, message?: str, error?: str}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| chapters | Yes | List of chapter objects with title and content | |
| filename | Yes | Desired filename (will be slugified, .md extension optional) | |
| introduction | Yes | Opening text that appears before any chapters | |
| keywords | Yes | List of searchable keywords | |
| project_id | Yes | The project identifier | |
| title | Yes | Human-readable document title for the metadata |