Skip to main content
Glama

Update Retention Policy

update_retention_policy
Destructive

Update or clear the default retention policy for a team workspace to control data lifecycle.

Instructions

Use when: Human-admin tool: update a team workspace retention policy. The API enforces owner/admin workspace permission; this tool does not accept actorId. Do not use when: a narrower tool better matches the intent, the project scope is unresolved, or the user has declined the action. Requires: authenticated API authority. Effect: canonical mutation. This mutation has no client idempotency key in the current contract; do not retry it automatically after an unknown outcome. Human approval: required before this action or its canonical follow-up. Then: follow typed result state; review pending proposals/drafts before any canonical apply. On failure: login_required → login; project_not_selected → list_projects/select_project; permission_denied → stop; stale_version or conflict → read current state; projection_pending → report canonical success separately and wait.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
teamWorkspaceIdYesTeam workspace id returned by team_onboarding_status.
defaultRetentionPolicyYesRetention policy JSON, or null to clear it.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
statusYes
warningsYes
authorityYes
projectIdYes
reviewUrlYes
idempotencyYes
nextActionsYes
reviewRequiredYes
canonicalVersionYes
projectionStatusYes
Behavior5/5

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

Discloses destructive nature (consistent with destructiveHint true), non-idempotency, no retry policy, and permission requirements. Adds significant context beyond annotations, such as 'canonical mutation' and 'no client idempotency key'.

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?

Well-structured with labeled sections and front-loaded purpose. Slightly verbose but all sentences add value; could be trimmed slightly without losing information.

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?

Covers usage context, prerequisites, effects, failure modes, and follow-up steps. With output schema present, this provides complete guidance for a mutation tool.

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?

Input schema coverage is 100% with good descriptions. Description adds no further parameter-level detail beyond what schema provides, so baseline score of 3 is appropriate.

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?

Clearly states 'update a team workspace retention policy' with specific verb and resource. Distinguishes from sibling tool 'get_retention_policy' and others via 'Human-admin tool' qualifier.

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?

Explicitly provides 'Use when' and 'Do not use when' conditions, including human approval requirement, permission constraints, and failure handling. Gives clear context for appropriate use.

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/my-abyss-project/abyss-mcp'

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