Get a server

Retrieve server details including connections, tools, and security status.

GET /servers/{qualifiedName}

JavaScript

JavaScript

import Smithery from '@smithery/api';

const client = new Smithery({
  apiKey: process.env['SMITHERY_API_KEY'], // This is the default and can be omitted
});

const server = await client.servers.get('qualifiedName');

console.log(server.connections);

200

{
  "qualifiedName": "smithery/hello-world",
  "displayName": "Hello World",
  "description": "A simple hello world server",
  "iconUrl": "https://example.com/icon.png",
  "remote": true,
  "deploymentUrl": "https://api.example.com",
  "connections": [
    {
      "type": "<string>",
      "bundleUrl": "<string>",
      "runtime": "node",
      "configSchema": {}
    }
  ],
  "security": {
    "scanPassed": true
  },
  "tools": [
    {
      "name": "get_weather",
      "description": "Get current weather",
      "inputSchema": {
        "type": "<string>",
        "properties": {}
      },
      "outputSchema": {
        "type": "<string>",
        "properties": {},
        "required": [
          "<string>"
        ]
      }
    }
  ],
  "resources": [
    {
      "name": "config://settings",
      "uri": "config://app/settings",
      "description": "Application settings",
      "mimeType": "application/json"
    }
  ],
  "prompts": [
    {
      "name": "summarize",
      "description": "Summarize the given text",
      "arguments": [
        {
          "name": "text",
          "description": "The text to summarize",
          "required": true
        }
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Smithery API key as Bearer token

Path Parameters

qualifiedName · string · required

The server's qualified name (e.g. 'namespace/server' or 'namespace' for namespace-only servers). Use %2F to encode the slash.

Response

200

application/json

Server found

qualifiedName · string · required

Example:

"smithery/hello-world"

displayName · string · required

Example:

"Hello World"

description · string · required

Example:

"A simple hello world server"

iconUrl · string | null · required

Example:

"https://example.com/icon.png"

remote · boolean · required

Example:

true

deploymentUrl · string | null · required

Example:

"https://api.example.com"

connections · object[] · required

Option 1

Option 2

Show child attributes

security · object · required

Show child attributes

tools · object[] | null · required

Show child attributes

resources · object[] | null · required

Show child attributes

prompts · object[] | null · required

Show child attributes