Skip to main content
Glama
SurfRankAI

SurfRank MCP Server

by SurfRankAI

get_report

Retrieve a single AI visibility report by ID, showing score, trends, and per-engine breakdowns to analyze performance.

Instructions

Get a single report by ID, including score, trends, and per-engine breakdowns.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYes
reportIdYes

Implementation Reference

  • Handler function for the 'get_report' tool. Makes a GET request to `/projects/{projectId}/reports/{reportId}` to retrieve a single report by ID, including score, trends, and per-engine breakdowns.
    handler: async ({ projectId, reportId }) =>
      api.get(`/projects/${projectId}/reports/${reportId}`),
  • Input schema for the 'get_report' tool, requiring 'projectId' (string) and 'reportId' (string) properties.
    inputSchema: {
      type: 'object',
      properties: {
        projectId: { type: 'string' },
        reportId: { type: 'string' },
      },
      required: ['projectId', 'reportId'],
    },
  • The full tool definition object for 'get_report', including name, description, inputSchema, and handler, exported as part of the reportTools array.
    {
      name: 'get_report',
      description: 'Get a single report by ID, including score, trends, and per-engine breakdowns.',
      inputSchema: {
        type: 'object',
        properties: {
          projectId: { type: 'string' },
          reportId: { type: 'string' },
        },
        required: ['projectId', 'reportId'],
      },
      handler: async ({ projectId, reportId }) =>
        api.get(`/projects/${projectId}/reports/${reportId}`),
    },
  • src/index.js:25-25 (registration)
    Import of reportTools from reports.js into the main server entry point.
    import { reportTools } from './tools/reports.js';
  • src/index.js:34-34 (registration)
    Spread of reportTools into the ALL_TOOLS array, making get_report available as an MCP tool.
    ...reportTools,
Behavior2/5

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

No annotations provided; description only states it returns data but does not disclose behavioral traits like required permissions, rate limits, or potential side effects. For a read operation, minimal disclosure.

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?

Single concise sentence with no fluff. Every word adds value.

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?

Adequate for a simple retrieval tool with two parameters and no output schema. Could mention response format or error conditions, but not essential.

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 description coverage is 0%; description does not explain the parameters projectId or reportId beyond 'by ID'. No added meaning over parameter names.

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?

Description clearly states verb 'Get' and resource 'a single report by ID', and specifies included data (score, trends, per-engine breakdowns). Distinguishes from siblings like list_reports and get_latest_analyses.

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?

Implied usage: use when you need a specific report by ID. No explicit when-to-use or alternatives guidance relative to siblings such as list_reports or get_latest_analyses.

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