Skip to main content
Glama

Set workspace profile

set_workspace_profile
Idempotent

Record who this workspace is: company or organization name, industry, who the page is mainly shared with, and one sentence on what it is used for. The web form for this was retired; this is the only way to write it. company_name is the sole source of the company name on WeChat share cards — without it recipients see a generated workspace name. Fields passed are merged into the existing profile and omitted fields are left unchanged, so changing only the company name needs only company_name. A first-time profile must supply the required fields: with usage=work, company name and industry are required; customer_type and use_case are required in both modes. Validation matches the retired web form exactly: placeholder names such as “personal”, “test” or “my company” are rejected (pass usage="personal" for personal use, which does not ask for company or industry), phone numbers and messaging handles are not allowed in the name, and industry must be one of the listed values. The profile is used for compliance and support and is not shown to viewers, except that the company name appears on share cards. Read-only members cannot call it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
usageNoUsage: work (default) means work use, where company name and industry are required; personal allows both to be empty.
industryNoIndustry (required when usage=work); must be one of the listed values.
use_caseNoOne sentence on what you will send and to whom, for example “send the weekly report to my team”.
company_nameNoCompany or organization name (required when usage=work). It appears on WeChat share cards.
customer_typeNoWho your pages are mainly shared with: b2b = colleagues, clients or partners; b2c = friends, family and other individuals.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations cover the safety profile (readOnlyHint=false, idempotentHint=true, destructiveHint=false), and the description adds substantial context beyond them: merge semantics ('fields passed are merged... omitted fields are left unchanged'), a permission restriction (read-only members cannot call), validation rules mirroring the retired form, and a visible side effect (company name on WeChat share cards).

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?

Front-loaded with the purpose, then conditions, then validation. It is dense rather than bloated, but the required-field rules and mode semantics are repeated between description and schema, costing a little efficiency.

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 5-param mutation tool with no output schema and no nested objects, the description covers everything an agent needs: merge vs. create behavior, per-mode required fields, validation constraints, permission gate, and the user-visible consequence. Nothing material is left to inference.

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?

Schema coverage is 100%, so the baseline is 3, but the description earns extra credit by explaining non-obvious parameter behavior: company_name is the sole source of the share-card name, placeholder values like 'personal'/'test' are rejected, phone numbers and handles are disallowed, and industry must be from the listed enum. It clarifies conditional requirements without merely restating the schema.

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?

Opens with a specific verb and resource ('Record who this workspace is') and enumerates the exact content domain: company/org name, industry, share audience, and use case. No sibling tool competes with this purpose, and an agent can immediately tell this writes the workspace profile.

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

Usage Guidelines5/5

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

Gives explicit when-to-use conditions: the retired web form makes this the only write path, and it spells out required fields per mode ('with usage=work, company name and industry are required; customer_type and use_case are required in both modes'). It also states the exclusion — read-only members cannot call it — and routes the personal case to usage="personal".

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources