Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OPENAI_API_KEY | Yes | Your OpenAI API key (required for AI features) |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_docs | List all available documentation files
Args:
directory: Optional subdirectory to list (relative to docs root)
Returns:
List of document metadata |
| search_docs | Search documentation using keyword matching (semantic search ready)
Args:
query: Search query string
max_results: Maximum number of results to return
search_content: Whether to search in document content
search_titles: Whether to search in document titles
Returns:
List of matching documents with relevance scores |
| ask_docs | Answer questions about documentation using AI
Args:
question: The question to answer
context_docs: Optional list of document paths to use as context
max_context_length: Maximum characters of context to include
user_id: Optional user identifier for rate limiting
Returns:
AI-generated answer with sources |
| index_docs | Index or re-index all documentation for improved search
Args:
rebuild: Whether to rebuild the entire index from scratch
Returns:
Indexing statistics |
| analyze_docs | Analyze documentation for specific tasks (foundation for agent handoffs)
Args:
task: Analysis task (e.g., "find_gaps", "generate_outline", "check_consistency")
docs: Optional list of specific documents to analyze
output_format: Output format (summary, detailed, structured)
Returns:
Analysis results ready for agent handoff |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| documentation_query | Generate a prompt for querying documentation Args: topic: The topic to query about detail_level: Level of detail (brief, medium, comprehensive) Returns: A formatted prompt for documentation queries |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |