Skip to main content
Glama

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
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • 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(),
          },
        ],
      };
    }
  • 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();
  • 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 }],
          };
        }
      );
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It states the tool provides 'comprehensive help and usage examples,' which suggests it's a read-only, informational resource without side effects. However, it lacks details on behavioral traits like response format, potential rate limits, or error handling, which would be useful given the absence of annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that clearly conveys the tool's function without any wasted words. It's front-loaded with the core purpose ('Get comprehensive help and usage examples') and specifies the scope ('for all Greptile MCP tools'), making it easy to understand at a glance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is adequate but could be more complete. It covers the basic purpose but doesn't address potential context like what 'comprehensive help' includes, whether it's interactive, or how it integrates with sibling tools. For a help tool in this environment, more detail on output or usage scenarios would enhance completeness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has 0 parameters, and schema description coverage is 100%, so there's no need for parameter details in the description. The baseline for 0 parameters is 4, as the description appropriately focuses on the tool's purpose without unnecessary parameter explanations.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Get comprehensive help and usage examples for all Greptile MCP tools.' It specifies the verb ('Get') and resource ('help and usage examples'), and the scope ('for all Greptile MCP tools') is well-defined. However, it doesn't explicitly differentiate from sibling tools like 'greptile_env_check' which might also provide system information.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context—when users need help or examples for Greptile tools—but doesn't provide explicit guidance on when to use this tool versus alternatives. There's no mention of prerequisites, timing, or comparisons to sibling tools like 'get_repository_info' or 'query_repository', leaving usage somewhat open to interpretation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/sosacrazy126/greptile-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server