Skip to main content
Glama
Cyreslab-AI

Shodan MCP Server

get_account_profile

Retrieve your Shodan account details, including membership status and available credits, to manage API usage and access levels.

Instructions

Get account profile information including membership status and credits

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Core handler function in ShodanClient that executes the API call to retrieve account profile from Shodan /account/profile endpoint.
    async getAccountProfile(): Promise<any> {
      try {
        const response = await this.axiosInstance.get("/account/profile");
        return response.data;
      } catch (error: unknown) {
        if (axios.isAxiosError(error)) {
          throw new McpError(
            ErrorCode.InternalError,
            `Shodan API error: ${error.response?.data?.error || error.message}`
          );
        }
        throw error;
      }
    }
  • MCP server tool call handler that invokes the ShodanClient.getAccountProfile method and formats the response.
    case "get_account_profile": {
      try {
        const accountProfile = await shodanClient.getAccountProfile();
        return {
          content: [{
            type: "text",
            text: JSON.stringify(accountProfile, null, 2)
          }]
        };
      } catch (error) {
        if (error instanceof McpError) {
          throw error;
        }
        throw new McpError(
          ErrorCode.InternalError,
          `Error getting account profile: ${(error as Error).message}`
        );
      }
    }
  • src/index.ts:1147-1154 (registration)
    Tool registration in the ListToolsRequestSchema response, including name, description, and empty input schema.
    {
      name: "get_account_profile",
      description: "Get account profile information including membership status and credits",
      inputSchema: {
        type: "object",
        properties: {}
      }
    },
  • Input schema definition for the tool (empty object since no parameters required).
    {
      name: "get_account_profile",
      description: "Get account profile information including membership status and credits",
      inputSchema: {
        type: "object",
        properties: {}
      }
    },
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 this is a 'Get' operation but doesn't specify whether this requires authentication, what permissions are needed, whether it's idempotent, or what format the response takes. For a tool that presumably accesses account data, this is a significant gap.

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 communicates the core purpose without unnecessary words. It's appropriately sized for a zero-parameter tool and front-loads the essential information.

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 zero-parameter tool with no output schema, the description provides basic purpose but lacks important context about authentication requirements, response format, and error conditions. Given that this appears to be an account information tool among security-focused siblings, more context about when and how to use it would be beneficial.

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 zero parameters with 100% schema description coverage, so the baseline is 4. The description appropriately doesn't discuss parameters since none exist, which is correct for this configuration.

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 with a specific verb ('Get') and resource ('account profile information'), including what information is retrieved ('membership status and credits'). However, it doesn't differentiate from sibling tools, which appear to be unrelated security/network tools rather than account management tools.

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. While sibling tools appear unrelated (security scanning, DNS lookups, CVE searches), there's no explicit statement about when this tool is appropriate or what prerequisites might exist.

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/Cyreslab-AI/shodan-mcp-server'

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