Skip to main content
Glama

relentless_index

Retrieve an index of database entries with slugs and titles for navigation or sitemap generation, providing faster access than full content retrieval.

Instructions

Get an index of all entries (slugs and titles only). This is faster than relentless_list when you only need to see what entries exist without their full content. Useful for navigation or sitemap generation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
databaseYesThe database name (e.g., "blog", "docs", "leads")
formatNoReturn format: "array" returns [{slug, title, url}], "object" returns {slug: {title, url}}array

Implementation Reference

  • Handler for the 'relentless_index' tool. Fetches the index of all entries (slugs and titles) from the specified database via the Relentless API, with optional format parameter.
    case 'relentless_index': {
      const { database, format = 'array' } = args as { database: string; format?: string }
    
      if (!database) {
        throw new McpError(ErrorCode.InvalidParams, 'Missing required parameter: database')
      }
    
      console.error(`[${new Date().toISOString()}] Getting index for ${database}`)
    
      const endpoint = `${RELENTLESS_API_BASE}/api/v1/public/db/${database}/index${
        format !== 'array' ? `?format=${format}` : ''
      }`
      const result = await relentlessRequest(endpoint)
    
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(result, null, 2),
          },
        ],
      }
    }
  • src/index.ts:279-300 (registration)
    Registration of the 'relentless_index' tool in the listTools response, including name, description, and input schema.
    {
      name: 'relentless_index',
      description:
        'Get an index of all entries (slugs and titles only). This is faster than relentless_list when you only need to see what entries exist without their full content. Useful for navigation or sitemap generation.',
      inputSchema: {
        type: 'object',
        properties: {
          database: {
            type: 'string',
            description: 'The database name (e.g., "blog", "docs", "leads")',
          },
          format: {
            type: 'string',
            enum: ['array', 'object'],
            description:
              'Return format: "array" returns [{slug, title, url}], "object" returns {slug: {title, url}}',
            default: 'array',
          },
        },
        required: ['database'],
      },
    },
  • Input schema definition for the 'relentless_index' tool, specifying database (required) and optional format.
    inputSchema: {
      type: 'object',
      properties: {
        database: {
          type: 'string',
          description: 'The database name (e.g., "blog", "docs", "leads")',
        },
        format: {
          type: 'string',
          enum: ['array', 'object'],
          description:
            'Return format: "array" returns [{slug, title, url}], "object" returns {slug: {title, url}}',
          default: 'array',
        },
      },
      required: ['database'],
    },
Behavior3/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It effectively communicates performance characteristics ('faster than relentless_list') and the limited data returned ('slugs and titles only'), but doesn't address potential limitations like pagination, rate limits, or error conditions that would be helpful for a read operation.

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 perfectly concise with two sentences that each earn their place. The first sentence establishes core functionality, the second provides comparative performance and use cases. No wasted words, front-loaded with essential information.

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

Completeness4/5

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

For a read-only tool with 2 parameters and 100% schema coverage but no output schema, the description provides good context about what data is returned and performance characteristics. However, without annotations or output schema, it could benefit from more detail about return format or error handling to be fully complete.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already fully documents both parameters. The description doesn't add any parameter-specific information beyond what's in the schema, but doesn't need to compensate for gaps. This meets the baseline expectation when schema coverage is complete.

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

Purpose5/5

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

The description clearly states the specific action ('Get an index'), resource ('all entries'), and scope ('slugs and titles only'). It explicitly distinguishes from sibling tool 'relentless_list' by explaining this is faster when full content isn't needed, establishing clear differentiation.

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

Usage Guidelines5/5

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

The description provides explicit guidance on when to use this tool ('when you only need to see what entries exist without their full content') and when to use an alternative ('faster than relentless_list'). It also mentions specific use cases ('navigation or sitemap generation'), giving clear context for selection.

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/PranaytheSingh/relentless-mcp'

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