greptile_help
Access help documentation and usage examples for Greptile MCP tools to understand their functionality and implementation.
Instructions
Get comprehensive help and usage examples for all Greptile MCP tools
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/server.ts:361-370 (handler)The main handler function for the greptile_help tool. It returns a content response containing the help markdown generated by getHelpContent().private async handleGreptileHelp(): Promise<{ content: Array<{ type: string; text: string }> }> { return { content: [ { type: 'text', text: await this.getHelpContent(), }, ], }; }
- src/server.ts:86-93 (schema)Schema definition for greptile_help tool in the listTools response, including name, description, and empty input schema.{ name: 'greptile_help', description: 'Get comprehensive help and usage examples for all Greptile MCP tools', inputSchema: { type: 'object', properties: {}, }, },
- src/server.ts:225-227 (registration)Registration and dispatch point in the CallToolRequestSchema handler switch statement.case 'greptile_help': return await this.handleGreptileHelp();
- src/server.ts:358-370 (helper)Full handler block including documentation comment./** * Handle greptile_help tool */ private async handleGreptileHelp(): Promise<{ content: Array<{ type: string; text: string }> }> { return { content: [ { type: 'text', text: await this.getHelpContent(), }, ], }; }
- src/index.ts:73-137 (registration)Alternative inline registration and handler in src/index.ts for Smithery/module use.// Register greptile_help tool server.registerTool( 'greptile_help', { title: 'Greptile Help', description: 'Get comprehensive help and usage examples for all Greptile MCP tools', inputSchema: {}, }, async () => { const helpContent = `# 🚀 Greptile MCP Server - Comprehensive Guide ## Overview The Greptile MCP Server provides AI-powered code search and querying capabilities through the Model Context Protocol (MCP). It integrates with the Greptile API to index repositories and answer natural language questions about codebases. ## Available Tools ### 1. \`greptile_help\` Get this comprehensive help documentation. ### 2. \`index_repository\` Index a repository to make it searchable for future queries. **Parameters:** - \`remote\`: "github" or "gitlab" - \`repository\`: Repository in "owner/repo" format - \`branch\`: Branch to index - \`reload\`: Force reprocessing (optional, default: true) - \`notify\`: Email notification (optional, default: false) ### 3. \`query_repository\` Query repositories using natural language to get detailed answers with code references. **Parameters:** - \`query\`: Natural language question - \`repositories\`: Array of repository objects - \`session_id\`: For conversation continuity (auto-generated if not provided) - \`stream\`: Enable streaming response (optional, default: false) - \`genius\`: Enhanced capabilities (optional, default: true) ### 4. \`get_repository_info\` Get information about an indexed repository. **Parameters:** - \`remote\`: Repository host - \`repository\`: Repository identifier - \`branch\`: Branch name ## Best Practices ### Repository Workflow 1. **Index** repositories first using \`index_repository\` 2. **Verify** indexing status with \`get_repository_info\` 3. **Query** using natural language with \`query_repository\` ### Session Management - Use consistent \`session_id\` across related queries for better context - Session continuity improves answer quality over multiple interactions For more information, visit: https://docs.greptile.com`; return { content: [{ type: 'text', text: helpContent }], }; } );