Skip to main content
Glama

chat.spaces.findDirectMessage

Finds the existing direct message space with a specified user, returning its details or a 404 error when no direct message exists.

Instructions

Returns the existing direct message with the specified user. If no direct message space is found, returns a 404 NOT_FOUND error. For an example, see Find a direct message. With app authentication, returns the direct message space between the specified user and the calling Chat app. With user authentication, returns the direct message space between the specified user and the authentica [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: completeImport, create, delete, findGroupChats, get, list, patch, search, setup.

Input Schema

NameRequiredDescriptionDefault
nameNo[query parameter] Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.g
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.

Output Schema

NameRequiredDescriptionDefault
nameNo
typeNo
customerNo
spaceUriNo
threadedNo
spaceTypeNo
createTimeNo
importModeNo
displayNameNo
spaceDetailsNo
accessSettingsNo
adminInstalledNo
lastActiveTimeNo
membershipCountNo
singleUserBotDmNo
spaceHistoryStateNo
permissionSettingsNo
externalUserAllowedNo
spaceThreadingStateNo
importModeExpireTimeNo
predefinedPermissionSettingsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.g"New value: +"[query parameter] Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.g"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "accessSettings": {
      +      "properties": {
      +        "accessPermissionSettings": {
      +          "properties": {
      +            "discoverSpaceSetting": {
      +              "properties": {
      +                "principals": {
      +                  "items": {
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "joinSpaceSetting": {
      +              "properties": {
      +                "principals": {
      +                  "items": {
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "viewSpaceMembershipSetting": {
      +              "properties": {
      +                "principals": {
      +                  "items": {
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "accessState": {
      +          "enum": [
      +            "ACCESS_STATE_UNSPECIFIED",
      +            "PRIVATE",
      +            "DISCOVERABLE"
      +          ],
      +          "type": "string"
      +        },
      +        "audience": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "adminInstalled": {
      +      "type": "boolean"
      +    },
      +    "createTime": {
      +      "type": "string"
      +    },
      +    "customer": {
      +      "type": "string"
      +    },
      +    "displayName": {
      +      "type": "string"
      +    },
      +    "externalUserAllowed": {
      +      "type": "boolean"
      +    },
      +    "importMode": {
      +      "type": "boolean"
      +    },
      +    "importModeExpireTime": {
      +      "type": "string"
      +    },
      +    "lastActiveTime": {
      +      "type": "string"
      +    },
      +    "membershipCount": {
      +      "properties": {
      +        "joinedDirectHumanUserCount": {
      +          "type": "integer"
      +        },
      +        "joinedGroupCount": {
      +          "type": "integer"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "name": {
      +      "type": "string"
      +    },
      +    "permissionSettings": {
      +      "properties": {
      +        "manageApps": {
      +          "properties": {
      +            "assistantManagersAllowed": {
      +              "type": "boolean"
      +            },
      +            "managersAllowed": {
      +              "type": "boolean"
      +            },
      +            "membersAllowed": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "manageMembersAndGroups": {
      +          "properties": {
      +            "assistantManagersAllowed": {
      +              "type": "boolean"
      +            },
      +            "managersAllowed": {
      +              "type": "boolean"
      +            },
      +            "membersAllowed": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "manageWebhooks": {
      +          "properties": {
      +            "assistantManagersAllowed": {
      +              "type": "boolean"
      +            },
      +            "managersAllowed": {
      +              "type": "boolean"
      +            },
      +            "membersAllowed": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "modifySpaceDetails": {
      +          "properties": {
      +            "assistantManagersAllowed": {
      +              "type": "boolean"
      +            },
      +            "managersAllowed": {
      +              "type": "boolean"
      +            },
      +            "membersAllowed": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "postMessages": {
      +          "properties": {
      +            "assistantManagersAllowed": {
      +              "type": "boolean"
      +            },
      +            "managersAllowed": {
      +              "type": "boolean"
      +            },
      +            "membersAllowed": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "replyMessages": {
      +          "properties": {
      +            "assistantManagersAllowed": {
      +              "type": "boolean"
      +            },
      +            "managersAllowed": {
      +              "type": "boolean"
      +            },
      +            "membersAllowed": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "toggleHistory": {
      +          "properties": {
      +            "assistantManagersAllowed": {
      +              "type": "boolean"
      +            },
      +            "managersAllowed": {
      +              "type": "boolean"
      +            },
      +            "membersAllowed": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "useAtMentionAll": {
      +          "properties": {
      +            "assistantManagersAllowed": {
      +              "type": "boolean"
      +            },
      +            "managersAllowed": {
      +              "type": "boolean"
      +            },
      +            "membersAllowed": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "viewSpaceMembership": {
      +          "properties": {
      +            "assistantManagersAllowed": {
      +              "type": "boolean"
      +            },
      +            "managersAllowed": {
      +              "type": "boolean"
      +            },
      +            "membersAllowed": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "predefinedPermissionSettings": {
      +      "enum": [
      +        "PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED",
      +        "COLLABORATION_SPACE",
      +        "ANNOUNCEMENT_SPACE"
      +      ],
      +      "type": "string"
      +    },
      +    "singleUserBotDm": {
      +      "type": "boolean"
      +    },
      +    "spaceDetails": {
      +      "properties": {
      +        "description": {
      +          "type": "string"
      +        },
      +        "guidelines": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "spaceHistoryState": {
      +      "enum": [
      +        "HISTORY_STATE_UNSPECIFIED",
      +        "HISTORY_OFF",
      +        "HISTORY_ON"
      +      ],
      +      "type": "string"
      +    },
      +    "spaceThreadingState": {
      +      "enum": [
      +        "SPACE_THREADING_STATE_UNSPECIFIED",
      +        "THREADED_MESSAGES",
      +        "GROUPED_MESSAGES",
      +        "UNTHREADED_MESSAGES"
      +      ],
      +      "type": "string"
      +    },
      +    "spaceType": {
      +      "enum": [
      +        "SPACE_TYPE_UNSPECIFIED",
      +        "SPACE",
      +        "GROUP_CHAT",
      +        "DIRECT_MESSAGE"
      +      ],
      +      "type": "string"
      +    },
      +    "spaceUri": {
      +      "type": "string"
      +    },
      +    "threaded": {
      +      "type": "boolean"
      +    },
      +    "type": {
      +      "enum": [
      +        "TYPE_UNSPECIFIED",
      +        "ROOM",
      +        "DM"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the burden well: it discloses the 404 NOT_FOUND failure mode, the auth-dependent result difference, and the HTTP GET nature, which is meaningful behavioral context. The trailing generic wrapper text about request bodies and body_file is boilerplate that doesn't add real behavioral insight for a GET.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core purpose and error behavior are front-loaded, which is good. But the description mixes in generic transport boilerplate ('request bodies are built from the typed parameters... or read whole from body_file') that is irrelevant to this GET endpoint and pads the definition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The output schema removes the need to describe return values, and the description covers the key behavioral facts: auth modes, 404 handling, and the resource lookup semantics. It's nearly complete for a lookup tool, missing only explicit sibling routing guidance.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the name parameter and its users/{user} format are already documented in the schema. The description adds no additional parameter detail beyond what the schema provides, so the baseline of 3 is appropriate.

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?

States a specific verb and resource: 'Returns the existing direct message with the specified user.' It's clearly a read lookup on a DM space rather than a create/get. However, it does not explicitly distinguish itself from close siblings like findGroupChats or get, relying on the appended generic sibling list instead of targeted differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides usage context by explaining the two authentication modes (app auth returns the DM between the user and the calling app; user auth returns it between the user and the authenticated user), which affects when/how to call. But there is no explicit guidance about when to prefer this over chat.spaces.get, findGroupChats, or search, and no stated exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools