DOCSEARCHbyAlgolia
Submit Docs

Gladys Assistant Documentation

website·Indexed 34 days ago

https://gladysassistant.com

Guides on authenticating with Gladys Assistant to control a user's smart home via the Model Context Protocol.

Tokens
420
Snippets
3
Records
6
Agent score
21%

What's inside Gladys Assistant

  1. Authenticate with Gladys Assistant via MCP

    Gladys Assistant uses human-provisioned API keys for authentication via the Model Context Protocol (MCP). There is no programmatic OAuth registration endpoint; the user must manually generate a key in their Gladys instance and provide it to the agent.

  2. Generate an MCP API key in Gladys

    Users must manually generate an API key to grant an agent access to their smart home. The key is shown only once upon generation.

    Steps for the user:

    1. Navigate to Integrations → MCP in the Gladys UI.
    2. Enter a client name (e.g., "Claude Desktop").
    3. Click Generate and copy the key.

  3. Discover Gladys Assistant authentication metadata

    To discover supported scopes and authentication methods, fetch the Protected Resource Metadata (PRM) and Authorization Server metadata. The PRM is the authoritative source in case of conflicts.
    GET https://gladysassistant.com/.well-known/oauth-protected-resource
GET https://gladysassistant.com/.well-known/oauth-authorization-server

  4. Handle API key revocation and errors

    Users can revoke API keys at any time via Integrations → MCP. If an agent receives a 401 or 403 response, it should treat this as a signal that the key has been revoked or is invalid and request a new key from the user.

  5. Use MCP credentials for remote access via Gladys Plus

    For remote access, users must subscribe to Gladys Plus and generate an Open API key at https://plus.gladysassistant.com/dashboard/settings/gateway-open-api. The API key is sent in the Authorization header.
    GET https://api.gladysgateway.com/v1/api/mcp/<GLADYS_PLUS_API_KEY>
Authorization: <GLADYS_PLUS_API_KEY>

  6. Use MCP credentials for local network access

    For Gladys instances on the local network, send the API key directly in the Authorization header without a Bearer prefix.
    POST http://GLADYS_IP/api/v1/service/mcp/proxy
Authorization: <LOCAL_API_KEY>