Skip to main content
Glama

get_report

Retrieve penetration testing reports by ID to access security assessment documentation, CVSS 3.1 scoring, and vulnerability details through authenticated API calls.

Instructions

Retrieve a specific report by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bearerTokenNoBearer token for authentication (optional if REPORTS_JWT_TOKEN env var is set)
reportIdYesThe ID of the report to retrieve (24-character MongoDB ObjectId)

Implementation Reference

  • The core handler function that validates the reportId, makes an authenticated GET request to the reports API endpoint using axios, and returns the report data as formatted JSON content or error response.
    async function getReport(providedToken, reportId) {
      try {
        const bearerToken = getBearerToken(providedToken);
        
        // Validate reportId format (should be MongoDB ObjectId)
        if (!reportId || !reportId.match(/^[0-9a-fA-F]{24}$/)) {
          throw new McpError(
            ErrorCode.InvalidParams,
            'Invalid reportId format. Must be a valid MongoDB ObjectId (24 characters)'
          );
        }
    
        const response = await axios.get(`${REPORTS_ENDPOINT}/${reportId}`, {
          headers: {
            'Authorization': `Bearer ${bearerToken}`,
            'Content-Type': 'application/json',
          },
          timeout: 10000,
        });
    
        return {
          content: [
            {
              type: 'text',
              text: JSON.stringify({
                success: true,
                status: response.status,
                data: response.data,
                timestamp: new Date().toISOString(),
                message: `Retrieved report ${reportId}`,
              }, null, 2),
            },
          ],
        };
      } catch (error) {
        if (error instanceof McpError) {
          throw error;
        }
        
        if (error.response) {
          return {
            content: [
              {
                type: 'text',
                text: JSON.stringify({
                  success: false,
                  status: error.response.status,
                  error: error.response.data || error.message,
                  timestamp: new Date().toISOString(),
                }, null, 2),
              },
            ],
          };
        } else if (error.request) {
          throw new McpError(
            ErrorCode.InternalError,
            `Network error: Unable to reach the API at ${REPORTS_ENDPOINT}/${reportId}`
          );
        } else {
          throw new McpError(
            ErrorCode.InternalError,
            `Request setup error: ${error.message}`
          );
        }
      }
    }
  • The JSON schema defining the input parameters for the 'get_report' tool: bearerToken (optional string) and required reportId (string). Defines validation rules and descriptions.
    inputSchema: {
      type: 'object',
      properties: {
        bearerToken: {
          type: 'string',
          description: 'Bearer token for authentication (optional if REPORTS_JWT_TOKEN env var is set)',
        },
        reportId: {
          type: 'string',
          description: 'The ID of the report to retrieve (24-character MongoDB ObjectId)',
        },
      },
      required: ['reportId'],
    },
  • server.js:834-850 (registration)
    Registration of the 'get_report' tool in the ListTools handler, including name, description, and input schema.
      name: 'get_report',
      description: 'Retrieve a specific report by ID',
      inputSchema: {
        type: 'object',
        properties: {
          bearerToken: {
            type: 'string',
            description: 'Bearer token for authentication (optional if REPORTS_JWT_TOKEN env var is set)',
          },
          reportId: {
            type: 'string',
            description: 'The ID of the report to retrieve (24-character MongoDB ObjectId)',
          },
        },
        required: ['reportId'],
      },
    },
  • server.js:1082-1089 (registration)
    Tool dispatch/registration in the CallToolRequestHandler switch statement: validates reportId and calls the getReport handler function.
    case 'get_report':
      if (!args.reportId) {
        throw new McpError(
          ErrorCode.InvalidParams,
          'Report ID is required'
        );
      }
      return await getReport(args.bearerToken, args.reportId);
Behavior2/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 states the tool retrieves data (implying read-only), but doesn't mention authentication requirements (though hinted in schema), rate limits, error conditions, or what the return format looks like. This is inadequate for a tool with potential auth needs.

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 with zero wasted words. It's front-loaded with the core purpose and appropriately sized for this simple retrieval operation.

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

Completeness2/5

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

Given no annotations, no output schema, and multiple sibling tools, the description is incomplete. It doesn't explain what a 'report' contains, how it differs from vulnerabilities, or what the return value looks like. For a retrieval tool in a complex domain, this leaves significant gaps.

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 documents both parameters thoroughly. The description adds no additional meaning beyond implying 'reportId' identifies the report, which the schema already states. This meets the baseline for high schema coverage.

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 action ('Retrieve') and resource ('a specific report by ID'), making the purpose unambiguous. However, it doesn't differentiate this tool from its sibling 'get_all_reports' (which likely retrieves multiple reports), so it doesn't reach the highest score.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'get_all_reports' or 'update_report'. It mentions retrieving by ID but doesn't specify prerequisites or exclusions, leaving usage context implied rather than 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/izzy0101010101/mcp-reports-server'

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