Skip to main content
Glama
Sign In

Aide

by app.aide
OverviewDiscussionsAdmin

Update the workspace

update_workspace
Destructive

Save the onboarding answers (the profile setup step); only the fields given change. Once the workspace has a name, a website or noWebsite, a channel and a use, onboarding is complete, as in the dashboard. Aide uses the answers in replies. A first website is imported as knowledge unless the workspace already has knowledge besides products, so add_website is not needed for it. Returns the workspace.

Input Schema

NameRequiredDescriptionDefault
nameNoThe company's name, as customers know it.
usesNoWhat Aide should do: `helpdesk` (the team answers from Aide), `ai_agent` (answer customers), `human_copilot` (draft replies for the team) or `other` (with otherUse); send with toolsUsed.
stageNoThe dashboard's onboarding step reached; only moves forward.
websiteNoA full URL, such as `https://example.com`.
channelsNoWhere customers contact it: `website_chat` (the Aide chat widget), `email` or `other` (with otherChannel); replaces the list.
industryNoThe company's industry, when the user says it.
otherUseNoWith uses `other`: what else Aide should do.
teamSizeNoPeople answering support, in the user's words.
completedNo`true` ends onboarding.
noWebsiteNo`true` when the company has no website.
toolsUsedNoTools the company uses today; send with uses.
contactEmailNoThe user's work email, when get_setup_status asks for one.
otherChannelNoWith channels `other`: which channel.
ticketsPerMonthNoTickets a month, in the user's words.
dismissedActionsNoDashboard reminder slugs to hide for good, such as `home-checklist`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / channels / items / enum
      Previous value: -[
-  "website_chat",
-  "email",
-  "other"
-]New value: +[
+  "website_chat",
+  "email",
+  "whatsapp",
+  "messenger",
+  "instagram",
+  "other"
+]
  2. Changed12 schema fields changed
    • changedInput schema / properties / channels / description
      Previous value: -"Where customers contact the company: `website_chat` (the Aide chat widget), `email` or `other` (with otherChannel); replaces the saved list."New value: +"Where customers contact it: `website_chat` (the Aide chat widget), `email` or `other` (with otherChannel); replaces the list."
    • addedInput schema / properties / completed
      Added value: +{
+  "description": "`true` ends onboarding.",
+  "type": "boolean"
+}
    • changedInput schema / properties / contactEmail / description
      Previous value: -"A work email for the user, asked when get_setup_status says they signed in with a personal address."New value: +"The user's work email, when get_setup_status asks for one."
    • addedInput schema / properties / dismissedActions
      Added value: +{
+  "description": "Dashboard reminder slugs to hide for good, such as `home-checklist`.",
+  "items": {
+    "maxLength": 120,
+    "type": "string"
+  },
+  "maxItems": 100,
+  "type": "array"
+}
    • changedInput schema / properties / industry / description
      Previous value: -"The company's industry, when the user says it; optional."New value: +"The company's industry, when the user says it."
    • changedInput schema / properties / noWebsite / description
      Previous value: -"`true` when the company has no website, instead of website."New value: +"`true` when the company has no website."
    • addedInput schema / properties / stage
      Added value: +{
+  "description": "The dashboard's onboarding step reached; only moves forward.",
+  "maximum": 4,
+  "minimum": 0,
+  "type": "integer"
+}
    • changedInput schema / properties / teamSize / description
      Previous value: -"How many people answer support, in the user's words, such as `5`."New value: +"People answering support, in the user's words."
    • changedInput schema / properties / ticketsPerMonth / description
      Previous value: -"Support tickets a month, in the user's words, such as `2,000`."New value: +"Tickets a month, in the user's words."
    • changedInput schema / properties / toolsUsed / description
      Previous value: -"The tools the company uses today. Saved together with uses: send both."New value: +"Tools the company uses today; send with uses."
    • changedInput schema / properties / uses / description
      Previous value: -"What Aide should do: `helpdesk` (be the inbox the team answers from), `ai_agent` (answer customers automatically), `human_copilot` (draft replies the team edits) or `other` (with otherUse). Saved together with toolsUsed: send both."New value: +"What Aide should do: `helpdesk` (the team answers from Aide), `ai_agent` (answer customers), `human_copilot` (draft replies for the team) or `other` (with otherUse); send with toolsUsed."
    • changedInput schema / properties / website / description
      Previous value: -"The company's website, a full URL such as `https://example.com`."New value: +"A full URL, such as `https://example.com`."
  3. Changed9 schema fields changed
    • addedInput schema / properties / channels
      Added value: +{
+  "description": "Where customers contact the company: `website_chat` (the Aide chat widget), `email` or `other` (with otherChannel); replaces the saved list.",
+  "items": {
+    "enum": [
+      "website_chat",
+      "email",
+      "other"
+    ],
+    "type": "string"
+  },
+  "type": "array",
+  "uniqueItems": true
+}
    • addedInput schema / properties / contactEmail
      Added value: +{
+  "description": "A work email for the user, asked when get_setup_status says they signed in with a personal address.",
+  "format": "email",
+  "maxLength": 254,
+  "type": [
+    "string",
+    "null"
+  ]
+}
    • addedInput schema / properties / noWebsite
      Added value: +{
+  "description": "`true` when the company has no website, instead of website.",
+  "type": "boolean"
+}
    • addedInput schema / properties / otherChannel
      Added value: +{
+  "description": "With channels `other`: which channel.",
+  "maxLength": 200,
+  "type": [
+    "string",
+    "null"
+  ]
+}
    • addedInput schema / properties / otherUse
      Added value: +{
+  "description": "With uses `other`: what else Aide should do.",
+  "maxLength": 114,
+  "type": "string"
+}
    • addedInput schema / properties / teamSize
      Added value: +{
+  "description": "How many people answer support, in the user's words, such as `5`.",
+  "maxLength": 40,
+  "type": [
+    "string",
+    "null"
+  ]
+}
    • addedInput schema / properties / ticketsPerMonth
      Added value: +{
+  "description": "Support tickets a month, in the user's words, such as `2,000`.",
+  "maxLength": 40,
+  "type": [
+    "string",
+    "null"
+  ]
+}
    • addedInput schema / properties / toolsUsed
      Added value: +{
+  "description": "The tools the company uses today. Saved together with uses: send both.",
+  "items": {
+    "enum": [
+      "gmail",
+      "gorgias",
+      "zendesk",
+      "front",
+      "shopify",
+      "woocommerce",
+      "salesforce"
+    ],
+    "type": "string"
+  },
+  "type": "array",
+  "uniqueItems": true
+}
    • addedInput schema / properties / uses
      Added value: +{
+  "description": "What Aide should do: `helpdesk` (be the inbox the team answers from), `ai_agent` (answer customers automatically), `human_copilot` (draft replies the team edits) or `other` (with otherUse). Saved together with toolsUsed: send both.",
+  "items": {
+    "enum": [
+      "helpdesk",
+      "ai_agent",
+      "human_copilot",
+      "other"
+    ],
+    "type": "string"
+  },
+  "type": "array",
+  "uniqueItems": true
+}
  4. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations declare destructiveHint=true and openWorldHint=true; the description adds real context beyond them by disclosing a non-obvious side effect — the first website is imported as knowledge unless the workspace already has knowledge besides products — and by clarifying that only supplied fields mutate. It does not explain what the destructive risk actually is (e.g., that list fields are replaced wholesale, which is only visible in the schema).

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?

It is front-loaded with the action and the mutation contract, and each subsequent sentence adds a distinct fact (completion criteria, downstream use of answers, website import shortcut, return value). The prose is dense and could be broken into shorter clauses, but nothing is redundant.

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?

For a 15-parameter, optional-all mutation with no output schema, the description covers the mutation model, the completion goal, the notable side effect, and the return value ("Returns the workspace"). Remaining gaps — such as the monotonic `stage` behavior and wholesale replacement of `channels` — are documented in the schema, so the definition is adequately complete overall.

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 3 baseline applies, but the description goes further by explaining cross-parameter completion rules and the partial-patch contract that no single property description conveys. Per-field meaning (enums, formats, lengths) is left entirely to the schema, which 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?

The description opens with a specific verb and resource — "Save the onboarding answers (the `profile` setup step)" — and adds partial-update semantics ("only the fields given change"). It also distinguishes itself from add_website for the first-website case, though it does not contrast itself with other update tools such as update_agent or set_up_helpdesk.

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?

It states the completion condition clearly (name, website or noWebsite, a channel, and a use) and tells the agent that add_website is not needed when the first website is provided here. It lacks an explicit "do not use when..." clause or a named alternative for later website additions, but the routing guidance is concrete.

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

All Aide toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources