Skip to main content
Glama

update_session

Edit existing session metadata – goal, topic, facilitation prompt, pre-session questions, and result visibility – to keep deliberation sessions aligned with current needs.

Instructions

Update session metadata. Mirrors the v1 PATCH /api/v1/sessions/[id] ALLOWED_UPDATE_FIELDS surface. Requires editor role.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
goalNoUpdated session goal
topicNoUpdated session topic
promptNoUpdated custom facilitation prompt
contextNoUpdated background context
criticalNoUpdated critical question or constraint
questionsNoPre-session questions. Replaces the existing pre-survey wholesale.
project_idNoMove the session into a project (workspace) by id, or pass `null` to detach it from all projects. Requires editor access to the target project. Attaching does not remove the session from any OTHER project it belongs to.
session_idYesSession ID (UUID)
template_idNoTemplate id that backs this session. Editing without recomposing the prompt (POST /sessions/[id]/regenerate-facilitation-prompt) leaves prompt + template out of sync. Pass `null` to detach.
distributionNoDistribution targets for channel integrations
prompt_summaryNoShort summary of the facilitation prompt (HAR-859). Usually written together with `prompt` by the regenerate-facilitation-prompt flow; setting manually outside that flow can confuse the Brief-drift banner.
summary_promptNoUpdated custom summarization prompt
intro_video_urlNoOptional intro video URL embedded on the session landing page. Pass `null` to clear.
welcome_messageNoMarkdown welcome message shown on the session landing page before participants enter chat.
widgets_enabledNoEnable AI-emitted Polls and ratings widgets (SingleSelect, MultiSelect, RatingScale, RankingList). Default false.
meta_descriptionNoSession-specific OG meta description for landing-page link previews.
cross_pollinationNoEnable/disable idea sharing between participant threads
results_visibilityNoWho can see aggregated results. "host" = owner only; "participants" = anyone who completed; "public" = anyone with the URL.
prompt_generated_fromNoSnapshot of the Brief fields that produced the current `prompt` (HAR-859). Brief-drift detection compares this against current topic/goal/critical/context.
platform_guidelines_overrideNoPer-session override of the Platform Guidelines block in the facilitation prompt (HAR-868). Pass `null` to fall back to the platform default.
Behavior3/5

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

No annotations are provided, so the description carries the burden. It adds 'Requires editor role' and 'Mirrors the v1 PATCH surface,' implying partial-update semantics. However, it doesn't mention return values, idempotency, or global side effects. Rated 3 because it provides some context but not full transparency.

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

Conciseness5/5

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

One concise sentence front-loads the core purpose ('Update session metadata') and adds only essential extra context (API surface, role requirement). No fluff.

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?

Tool has 20 parameters with rich per-parameter descriptions in the schema, including behavioral caveats like wholesale replacement of questions and template/prompt out-of-sync risks. The main description adds the API surface and role requirement. Missing return-value info, but the schema covers most contextual needs. Given the absence of an output schema, a brief mention of the response would make it fully complete.

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 baseline is 3. The description adds no parameter-specific detail beyond the ALLOWED_UPDATE_FIELDS reference, but the schema itself documents every parameter thoroughly. No need for more from the description.

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 'Update session metadata' is a specific verb+resource, clearly distinguishing it from siblings like create_session, get_session, and list_sessions. The API endpoint reference reinforces the exact operation.

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?

Clear context: use to update existing session metadata. States prerequisite 'Requires editor role.' Does not explicitly exclude alternatives, but the purpose is unambiguous relative to sibling tools. Lacks when-not-to-use guidance, so not a 5.

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/harmonicabot/harmonica-mcp'

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