Skip to main content
Glama

Update Site Profile

qualitykit.update_site_profile

Apply partial Site Profile patches for brand identity, ICP, products, and SEO fields, keeping material updates pending until approved and syncing to Cloud when an API key is set.

Instructions

Apply a partial Site Profile patch. Brand identity, ICP, and products stay pendingApproval until approveMaterial or approvePending. Persists to Cloud when API key is set.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "projectRoot": "<projectRoot>",
      "patch": "<patch>"
    },
    "name": "qualitykit.update_site_profile"
  }
}

Input Schema

NameRequiredDescriptionDefault
patchYesPartial profile field updates
apiKeyNo
siteUrlNo
apiBaseUrlNo
projectRootYesAbsolute path to the website repository root
approvePendingNoApprove previously pending material fields
approveMaterialNoWhen true, apply brandIdentity/icp/products immediately (user confirmed). Otherwise those fields stay pendingApproval.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A3.5/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full behavioral burden. It does add real value by disclosing the pendingApproval gating for brandIdentity/icp/products and that data persists to Cloud when an API key is provided — neither of which is fully spelled out in the schema. However, it says nothing about merge-vs-replace semantics for nested fields, whether existing values are overwritten, required permissions, or what is returned.

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?

Three short sentences, front-loaded with the core action, with no filler. Each sentence contributes a distinct fact: what it does, the approval gate, and the persistence condition.

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

Completeness3/5

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

For a mutation tool with no annotations, no output schema, and a nested patch parameter, the description covers the highest-risk behavior (approval gating, cloud sync) but leaves gaps around what a partial patch does to untouched fields, how deep the merge goes, and what the caller gets back. Adequate but not sufficient to call this safely without inspecting the schema.

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 coverage is 57% with seven parameters including a nested patch object, so the description should compensate more than it does. It explains the approveMaterial/approvePending effect on the three gated fields and implies apiKey drives Cloud persistence, but siteUrl, apiBaseUrl, and the confidence/source/evidence structure inside patch entries go unaddressed.

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?

States a specific verb and resource ('Apply a partial Site Profile patch'), which cleanly separates it from get_site_profile (read) and refresh_site_profile (regenerate). It stops short of naming those siblings or explicitly saying it is the write path, so sibling differentiation is inferred rather than stated.

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

Usage Guidelines3/5

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

Usage is implied by the word 'patch' and by the approval rules, but there is no explicit 'use this when you need to modify profile fields' or 'use get_site_profile instead if you only need to read'. The approval escape hatches (approveMaterial, approvePending) are mentioned as mechanisms without guidance on when an agent should reach for them.

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