Skip to main content
Glama
SurfRankAI

SurfRank MCP Server

by SurfRankAI

list_reports

Retrieve the most recent reports for a specific project, ordered by date. Use project ID to filter and optionally set a limit on results.

Instructions

List recent reports for a project (most recent first).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYes
limitNoMax reports to return. Default 10.

Implementation Reference

  • The handler function for 'list_reports' that calls the API GET endpoint `/projects/${projectId}/reports` with an optional limit parameter.
      handler: async ({ projectId, limit }) =>
        api.get(`/projects/${projectId}/reports`, { limit }),
    },
  • Input schema for 'list_reports', specifying projectId (required, string) and limit (optional number, default 10).
    inputSchema: {
      type: 'object',
      properties: {
        projectId: { type: 'string' },
        limit: { type: 'number', description: 'Max reports to return. Default 10.' },
      },
      required: ['projectId'],
    },
  • src/index.js:25-34 (registration)
    'list_reports' is registered as part of the reportTools array, imported from reports.js and spread into ALL_TOOLS on line 34.
    import { reportTools } from './tools/reports.js';
    import { quickTestTools } from './tools/quickTest.js';
    import { keywordResearchTools } from './tools/keywordResearch.js';
    import { competitorTools } from './tools/competitors.js';
    import { opportunityTools } from './tools/opportunities.js';
    
    const ALL_TOOLS = [
      ...projectTools,
      ...keywordTools,
      ...reportTools,
  • The HTTP client helper providing api.get() which the handler uses to make the GET request to the reports endpoint.
    export const api = {
      get: (path, query) => request('GET', path, { query }),
      post: (path, body) => request('POST', path, { body }),
      patch: (path, body) => request('PATCH', path, { body }),
      delete: (path) => request('DELETE', path),
    };
Behavior3/5

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

No annotations are provided, so the description must bear the burden of behavioral disclosure. It mentions ordering ('most recent first') but lacks details on pagination, field contents, authentication, or any side effects. This adds some value but is incomplete.

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?

A single, front-loaded sentence that efficiently conveys the core purpose. No superfluous words; every part is necessary.

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?

For a simple list tool with 2 parameters and no output schema, the description is somewhat complete but lacks details on output format, pagination, or how 'recent' is defined. Given similar sibling tools, more context would help differentiation.

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

Parameters2/5

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

Schema describes 'projectId' and 'limit' (with description). The description adds no extra meaning to projectId beyond 'for a project'. For limit, the schema already states 'Max reports to return. Default 10.' The description does not compensate for the 50% schema coverage.

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?

Clear verb and resource: 'list recent reports for a project' specifies exactly what the tool does and distinguishes it from 'get_report' (single report) and 'trigger_report' (create).

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 states it lists recent reports for a project but provides no guidance on when to use it over other listing tools (e.g., list_keywords, list_opportunities) or any exclusions. Usage context is implied but not explicit.

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/SurfRankAI/mcp-server'

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