get_started_guide
Delivers comprehensive project documentation and usage guidelines for AI assistants to understand user requirements, recommend tools, and avoid common pitfalls.
Instructions
🌟 Getting Started Guide: Your Gateway to the ask-ollama Project
⚠️ AI Assistant Note:
Before proceeding with any operations, it's highly recommended to:
1. Ask the user if they're new to the project
2. Explain that this guide will provide comprehensive understanding
3. Mention that this tool contains essential information for optimal project usage
Why this guide is essential for AI assistants:
1. Provides complete project overview and capabilities
2. Contains special instructions for AI-user interactions
3. Details recommended workflows and best practices
4. Lists all available tools with practical examples
5. Explains current limitations and workarounds
6. Includes API documentation navigation guide
This guide will help you:
- Better understand user requirements
- Make informed tool recommendations
- Navigate API documentation effectively
- Avoid common pitfalls
- Provide more accurate assistance
Remember: Running this guide first will significantly enhance your ability to assist users effectively.
Args:
None: This function does not require any parameters.
Returns:
str: JSON-formatted string containing comprehensive project documentation and usage guidelines.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |