Skip to main content
Glama

x_api_add_chat_group_members

Add members to a Chat group conversation, allowing you to update the group's roster with new participants.

Instructions

Add members to a Chat group conversation. Use when: Add members to a Chat group conversation. Do not use when: a more specific auth/configuration tool is required before the API call or you are only exploring; prefer x_schema_discovery or x_query_suggestion first. Risk: mutating, high-risk. Required permissions and prerequisites: OAuth 2 user token with scopes dm.write, tweet.read, users.read; OAuth 1a user token Environment-selection behavior: scopeTenantId plus exactly one of scopeUserId or scopeAccountId choose the Vault/Postgres tenant principal used for auth resolution. credentialKey selects a non-default stored credential profile when present. Parameter formats and constraints: id (path, unknown, required); body is used for the documented request payload. Expected response shape: { ok, status, data: { method, path, url, status, contentType, authType, data } } Common failure conditions: missing scoped credentials in Vault, missing required API parameters, X API auth failures, rate limits, or unsupported multipart/body shape. Recommended prerequisite and follow-up tools: x_connection_info, x_schema_discovery, x_auth_upsert_principal_credentials, x_api_request. Safety warnings: This mutates X state. Validate scope, payload, and authorizationKey before use. Example: {"name":"x_api_add_chat_group_members","arguments":{"scopeTenantId":"default","scopeUserId":"default","id":"","body":{}}}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
bodyNo
scopeUserIdNo
credentialKeyNo
scopeTenantIdNo
scopeAccountIdNo
authorizationKeyNo
preferredAuthTypeNo
Behavior5/5

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

With no annotations provided, the description fully carries the burden. It explicitly labels the tool 'mutating, high-risk', warns to 'Validate scope, payload, and authorizationKey before use', details required OAuth scopes, explains environment-selection behavior, lists common failure conditions, and provides an expected response shape. This is exemplary disclosure for a mutation tool.

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

Conciseness4/5

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

The description is well-organized with labeled sections, front-loaded with the core action. It avoids excessive fluff, but there is redundancy: 'Add members to a Chat group conversation' appears both as the opening and again in 'Use when'. The structure is clear and each section adds value, so it earns a strong score despite minor repetition.

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

Completeness5/5

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

For a complex mutating tool with 8 parameters, no output schema, and no annotations, the description is remarkably complete. It covers permissions, risk, environment-selection, parameter roles, response shape, failure conditions, recommended companion tools, and an example. This gives an agent sufficient information to select and invoke the tool correctly.

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

Parameters4/5

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

Despite 0% schema coverage, the description explains key parameters: 'id (path, unknown, required)', 'body is used for the documented request payload', and the role of scopeTenantId, scopeUserId, scopeAccountId, and credentialKey in auth resolution. It also gives a concrete example with argument names. However, it does not elaborate on the structure of 'body', which would be the payload for adding members.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Add members to a Chat group conversation' with a specific verb and resource, clearly distinguishing it from sibling chat tools like create_chat_conversation or send_chat_message. The action is unambiguous and scoped to chat group membership.

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

Usage Guidelines4/5

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

The 'Use when' section merely restates the purpose, but the 'Do not use when' provides valuable exclusions: avoid when a more specific auth/configuration tool is needed or when exploring, preferring x_schema_discovery or x_query_suggestion. This gives context for when not to invoke, though it doesn't compare this tool to other mutation tools for chat groups specifically.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/LesterAJohn/X-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server