> ## Documentation Index
> Fetch the complete documentation index at: https://acm-aa28ebf6.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Server

> Retrieve detailed information about a specific MCP server

## Endpoint

<Card>
  <code>GET [https://api.superbox.ai/api/v1/servers/:name](https://api.superbox.ai/api/v1/servers/:name)</code>
</Card>

## Authentication

This endpoint does not require authentication. All server details are publicly accessible.

## Path Parameters

<ParamField path="name" type="string" required>
  Unique server identifier (lowercase with hyphens). **Example:** `weather-mcp`
</ParamField>

## Response

<ResponseField name="status" type="string">
  `"success"` on success, `"error"` on failure
</ResponseField>

<ResponseField name="server" type="object">
  Detailed server information

  <Expandable title="Server Object">
    <ResponseField name="name" type="string" required>
      Unique server identifier
    </ResponseField>

    <ResponseField name="version" type="string" required>
      Current semantic version
    </ResponseField>

    <ResponseField name="description" type="string" required>
      Detailed description of the server's functionality
    </ResponseField>

    <ResponseField name="author" type="string" required>
      Server creator/maintainer name
    </ResponseField>

    <ResponseField name="lang" type="string" required>
      Programming language (`python`, `javascript`, `typescript`, `go`, `rust`)
    </ResponseField>

    <ResponseField name="license" type="string" required>
      Software license (`MIT`, `Apache-2.0`, `GPL-3.0`, etc.)
    </ResponseField>

    <ResponseField name="entrypoint" type="string" required>
      Entry point file for server execution
    </ResponseField>

    <ResponseField name="repository" type="object" required>
      Repository information

      <Expandable title="properties">
        <ResponseField name="type" type="string">
          Repository type (usually `"git"`)
        </ResponseField>

        <ResponseField name="url" type="string">
          Full repository URL
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="tools" type="object">
      Available tools information

      <Expandable title="properties">
        <ResponseField name="count" type="integer">
          Total number of tools provided
        </ResponseField>

        <ResponseField name="names" type="array">
          Array of tool names
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pricing" type="object" required>
      Pricing information

      <Expandable title="properties">
        <ResponseField name="currency" type="string">
          Currency code (e.g., `"INR"`)
        </ResponseField>

        <ResponseField name="amount" type="number">
          Price amount (`0` for free servers)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="security_report" type="object">
      Comprehensive security scan results

      <Expandable title="properties">
        <ResponseField name="metadata" type="object">
          Scan metadata including `repository`, `repo_url`, `scan_date`, and `scanners_used`
        </ResponseField>

        <ResponseField name="summary" type="object">
          Summary with `scan_passed`, `total_issues_all_scanners`, `critical_issues`, and `sonarcloud_url`
        </ResponseField>

        <ResponseField name="sonarcloud" type="object">
          SonarCloud analysis results
        </ResponseField>

        <ResponseField name="gitguardian" type="object">
          GitGuardian secrets detection results
        </ResponseField>

        <ResponseField name="bandit" type="object">
          Bandit security audit results (Python only)
        </ResponseField>

        <ResponseField name="recommendations" type="array">
          Array of security recommendations
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

## Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.superbox.ai/api/v1/servers/weather-mcp"
  ```

  ```javascript JavaScript theme={null}
  const serverName = 'weather-mcp';
  const response = await fetch(
    `https://api.superbox.ai/api/v1/servers/${serverName}`
  );
  const { server } = await response.json();

  console.log(`${server.name} v${server.version}`);
  console.log(`Tools: ${server.tools.names.join(', ')}`);

  // Check security status
  if (server.security_report?.summary.scan_passed) {
    console.log('Security scan passed');
  } else {
    console.warn('Security issues found');
  }
  ```

  ```python Python theme={null}
  import requests

  server_name = "weather-mcp"
  response = requests.get(
      f"https://api.superbox.ai/api/v1/servers/{server_name}"
  )
  server = response.json()['server']

  print(f"{server['name']} v{server['version']}")
  print(f"Author: {server['author']}")
  print(f"Language: {server['lang']}")
  print(f"Tools: {', '.join(server['tools']['names'])}")

  # Check pricing
  if server['pricing']['amount'] == 0:
      print("This server is FREE!")
  else:
      print(f"Price: {server['pricing']['currency']} {server['pricing']['amount']}")
  ```

  ```go Go theme={null}
  package main

  import (
  "encoding/json"
  "fmt"
  "net/http"
  )

  func main() {
  serverName := "weather-mcp"
  url := fmt.Sprintf("https://api.superbox.ai/api/v1/servers/%s", serverName)

  resp, err := http.Get(url)
  if err != nil {
  panic(err)
  }
  defer resp.Body.Close()

  var result struct {
  Status string `json:"status"`
  Server struct {
  Name    string `json:"name"`
  Version string `json:"version"`
  Author  string `json:"author"`
  } `json:"server"`
  }

  json.NewDecoder(resp.Body).Decode(&result)

  fmt.Printf("%s v%s by %s\n",
  result.Server.Name,
  result.Server.Version,
  result.Server.Author)
  }
  ```
</CodeGroup>

## Response Examples

<ResponseExample>
  ```json 200 Success theme={null}
  {
    "status": "success",
    "server": {
      "name": "weather-mcp",
      "version": "1.2.3",
      "description": "Get real-time weather information, forecasts, and location search using the OpenWeatherMap API.",
      "author": "areeb",
      "lang": "python",
      "license": "MIT",
      "entrypoint": "main.py",
      "repository": {
        "type": "git",
        "url": "https://github.com/areeb/weather-mcp"
      },
      "tools": {
        "count": 3,
        "names": ["get_weather", "get_forecast", "search_location"]
      },
      "pricing": {
        "currency": "INR",
        "amount": 0
      },
      "security_report": {
        "metadata": {
          "repository": "weather-mcp",
          "repo_url": "https://github.com/areeb/weather-mcp",
          "scan_date": "2025-12-09T08:00:00Z",
          "scanners_used": ["SonarCloud", "Tool Discovery", "Snyk", "GitGuardian", "Bandit"]
        },
        "summary": {
          "total_issues_all_scanners": 0,
          "critical_issues": 0,
          "sonarcloud_url": "https://sonarcloud.io/dashboard?id=weather-mcp",
          "scan_passed": true
        },
        "sonarcloud": {
          "total_issues": 0,
          "bugs": 0,
          "vulnerabilities": 0,
          "code_smells": 0,
          "security_hotspots": 0,
          "quality_gate": "passed",
          "reliability_rating": "A",
          "security_rating": "A",
          "maintainability_rating": "A",
          "coverage": 85.4,
          "duplications": 0.5,
          "lines_of_code": 342
        },
        "gitguardian": {
          "scan_passed": true,
          "total_secrets": 0,
          "secrets": [],
          "error": null
        },
        "bandit": {
          "scan_passed": true,
          "total_issues": 0,
          "severity_counts": {
            "high": 0,
            "medium": 0,
            "low": 0
          },
          "total_lines_scanned": 342,
          "issues": [],
          "error": null
        },
        "recommendations": []
      }
    }
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "status": "error",
    "detail": "Server not found"
  }
  ```
</ResponseExample>

## Use Cases

<AccordionGroup>
  <Accordion title="Display Server Details" icon="eye">
    ```javascript theme={null}
    async function displayServerPage(serverName) {
      const response = await fetch(
        `https://api.superbox.ai/api/v1/servers/${serverName}`
      );
      const { server } = await response.json();

      document.getElementById('name').textContent = server.name;
      document.getElementById('version').textContent = server.version;
      document.getElementById('description').textContent = server.description;
      document.getElementById('tools').innerHTML =
        server.tools.names.map(tool => `<li>${tool}</li>`).join('');
    }
    ```
  </Accordion>

  <Accordion title="Check Security Status" icon="shield">
    ```python theme={null}
    def is_server_secure(server_name):
        response = requests.get(
            f'https://api.superbox.ai/api/v1/servers/{server_name}'
        )
        server = response.json()['server']

        security = server.get('security_report', {}).get('summary', {})
        return security.get('scan_passed', False) and \
               security.get('critical_issues', 1) == 0

    if is_server_secure('weather-mcp'):
        print("Server is secure")
    else:
        print("Security concerns found")
    ```
  </Accordion>
</AccordionGroup>

## Related Endpoints

<CardGroup cols={2}>
  <Card title="List Servers" icon="list" href="/api/servers/list">
    Browse all available MCP servers
  </Card>

  <Card title="Create Server" icon="plus" href="/api/servers/create">
    Deploy a new MCP server
  </Card>
</CardGroup>
