query_update
Validate and save changes to a query draft. Publishing is a separate step with query_publish.
When to use it
Use query_update to update a query draft. On the workspace endpoint, pass projectId from project_list. On a project-scoped endpoint, the project is already bound: omit that argument and use the schema discovered from that endpoint.
Arguments
| Name | Type | Required | Default | Constraints |
|---|---|---|---|---|
queryId | string | Yes | — | Format: uuid; Pattern constraint; see full schema |
changes | object | Yes | — | Fields: name, description, content, authoringMode, aiPrompt |
idempotencyKey | string | Yes | — | Minimum length: 8; Maximum length: 200 |
projectId | string | Yes | — | Format: uuid; Pattern constraint; see full schema |
View the complete input schema, including nested contracts and alternative shapes. The schema is extracted from the workspace server’s Zod definitions. Runtime validation also enforces custom checks that JSON Schema cannot express.
Response shape
The implementation constructs payloads using these fields: query. The returned fields depend on the execution path.
MCP returns a text block containing the JSON operation result and a
structuredContent copy. The envelope includes data, completeness,
truncated, freshness, and warnings. Depending on the operation it can also
include nextCursor, evidence, job, or receipt.
Check those fields before treating a conversational summary as the result.
When a job is returned, inspect its status with the appropriate execution tool;
a queued response is not confirmation that work finished. Follow evidence links
when checking the underlying records.
Input methods
This request illustrates the argument structure. Replace every angle-bracket placeholder with a real value and supply any applicable optional fields from the schema. Nested business contracts must match your actual configuration. Send it through an authenticated, initialized MCP client; this JSON alone does not establish a session or sign you in.
Open the project’s Ontology → Queries authoring flow. Describe the query to the assistant, or use the manual YAML editor for its definition. Fill its name and description, validate, then save. A query draft is not a published executable release.
Use Semogram’s query_update tool to update a query draft. Inspect the required inputs and target first, then show me what will change before executing it.
Choose the project explicitly before making this request. Use real resource IDs returned by earlier reads; a resource name is not a UUID. Do not fill missing business inputs with invented values.
Use a workspace API key with queries:write. Set SEMOGRAM_API_KEY in your shell; replace resource placeholders with real IDs. This is an HTTP resource request, not an MCP JSON-RPC message.
curl --request PUT "https://platform.semogram.com/api/v1/projects/<PROJECT_ID_UUID>/ontology/queries/<QUERY_ID_UUID>" \
--header "Authorization: Bearer ${SEMOGRAM_API_KEY}" \
--header "Content-Type: application/json" \
--data-binary @- <<'JSON'
{}
JSONThis is an MCP tools/call request, not a form to paste into Semogram. Send it through an authenticated, initialized MCP client.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "query_update",
"arguments": {
"queryId": "<QUERY_ID_UUID>",
"changes": {},
"idempotencyKey": "<UNIQUE_KEY_FOR_THIS_OPERATION>",
"projectId": "<PROJECT_ID_UUID>"
}
}
}FAQ
What access and approvals are required?
Required permission scopes: queries:write.
OAuth uses current workspace membership; API keys use their assigned scopes
and grants. Discovery can exclude tools the caller cannot use.
Read-only annotation: No. Destructive annotation: No. Follow the operation’s declared contract and any applicable server-side approval policy.
How should I handle retries?
The server marks this operation as idempotent. When an idempotencyKey is accepted, keep the same key only for a retry of the exact same input; use a new key for new work. For 429 responses, honor Retry-After rather than retrying immediately.
Why is this tool missing or returning an error?
Confirm the workspace, resource IDs, and permission scopes. Read the returned error before changing the request. See connection, authentication and troubleshooting for sign-in, scope, resource access, and rate-limit errors.