serpmantics

update_guide

update_guide

Update a guide

Updates editable fields of a specific guide (group, status, share state, linked URL, meta, hidden expressions). Only owners may update.

Input Schema

TableJSON Schema

Name	Required	Description
`id`	Yes	The ID of the guide to update
`meta`	No	SEO meta override for the guide
`group`	No	Group/folder the guide belongs to (triggers cannibalisation analysis on previous and new group)
`status`	No	Editorial status of the guide. Empty string clears the status.
`linkedUrl`	No	Public URL where the guide content is published (validated as URL)
`shareState`	No	Sharing mode. Plan must allow shared-read or shared-edit, otherwise 403 is returned.
`hiddenExpressions`	No	Expressions to hide from the optimisation suggestions

TDQS

B3.3/5.0

Behavior3/5

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

Covers ownership restriction and lists editable fields. With no annotations, description carries full burden but misses side effects (e.g., cannibalisation analysis on group change) and return behavior.

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?

Two sentences, mostly to the point. First sentence is slightly redundant with title, but overall efficient.

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

Completeness2/5

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

No output schema, no info on return values, partial updates, or idempotency. Missing context for a tool with 7 params and nested objects.

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 100%, so baseline 3. Description lists parameter names matching schema but adds no extra validation or examples beyond schema.

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?

Clearly states 'Update a guide' and lists editable fields, distinguishing it from siblings like get_guide or delete_guide. However, description doesn't explicitly differentiate from potential update-like tools.

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?

Mentions 'Only owners may update', providing a usage condition. But lacks guidance on when not to use or alternatives for similar operations.

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

All serpmantics tools Inspect

Try in Browser

RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

B3.4/5.0

Disambiguation4/5

Most tools target distinct resources (guides, eeat, intent, internal_links, meta, outline, score, credits, tokens). However, some pairs like create_eeat and create_eeat_competitors are very similar and could cause confusion, though their descriptions clarify the difference.

Naming Consistency4/5

Tools consistently use a verb_noun pattern (create_, get_, delete_). Minor inconsistencies include 'get_aissistant_tokens' (typo) and 'get_credit_ledger' (singular vs plural), but overall the pattern is clear.

Tool Count4/5

28 tools is on the higher end but justifiable for a comprehensive SEO analysis platform covering guides, multiple AI features, EEAT, credits, and tokens. A few tools could be merged (e.g., get_credits and get_aissistant_tokens), but the count is still reasonable.

Completeness4/5

The tool surface covers CRUD for guides and most AI features, plus token/credit management. A notable gap is the lack of a get_score tool after create_score, and some features like updating EEAT analysis are absent. Overall, the core workflows are supported.

Resources

Need Help?