SoulFire TypeScript SDK 2.10.3
    Preparing search index...
    ServerInfo: Message<"soulfire.v1.ServerInfo"> & {
        branchName: string;
        commitHash: string;
        minecraftVersion: string;
        publicApiAddress: string;
        publicDocsAddress: string;
        publicMcpAddress: string;
        publicWebdavAddress: string;
        version: string;
    }

    Contains metadata about the SoulFire server instance. This information is useful for client compatibility checks and connecting to related services.

    Type Declaration

    • branchName: string

      The git branch name from which the server was built (e.g., "main", "develop").

      from field: string branch_name = 3;

    • commitHash: string

      The git commit hash of the server build, useful for debugging and version tracking.

      from field: string commit_hash = 2;

    • minecraftVersion: string

      The native Minecraft protocol version supported by this server (e.g., "1.21.4").

      from field: string minecraft_version = 7;

    • publicApiAddress: string

      The public URL for the gRPC/HTTP API endpoint. This is the base address clients should use to connect to the server.

      from field: string public_api_address = 4;

    • publicDocsAddress: string

      The public URL for the API documentation endpoint. Derived from public_api_address with "/docs" appended.

      from field: string public_docs_address = 6;

    • publicMcpAddress: string

      The public URL for the MCP (Model Context Protocol) endpoint. Derived from public_api_address with "/mcp" appended. Clients can use this to connect AI assistants to the SoulFire server.

      from field: string public_mcp_address = 8;

    • publicWebdavAddress: string

      The public URL for the WebDAV file access endpoint. Derived from public_api_address with "/webdav" appended.

      from field: string public_webdav_address = 5;

    • version: string

      The semantic version of the SoulFire server (e.g., "1.0.0").

      from field: string version = 1;

    from message soulfire.v1.ServerInfo