create_internal_linksGenerate internal linking suggestions for a guide
Analyzes a guide and generates internal linking suggestions based on content analysis. Note: This endpoint uses tokens (check /api/v1/tokens-usage for the cost, might vary).
| Name | Required | Description | Default |
|---|---|---|---|
| guideId | Yes | ID of the guide |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description bears full burden. It discloses token usage and content analysis, but omits key behavioral traits: whether it is a write operation, if it modifies the guide, or if it is destructive. Incomplete for a mutation tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise with two sentences and a note, front-loading the main purpose. The token usage note adds value without excessive length, though structure could be slightly improved.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simple input schema and no output schema, the description covers the basic purpose and token cost. However, it lacks completeness about expected behavior (e.g., synchronous? impact on guide?) making it adequate but with gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with a single parameter 'guideId' described as 'ID of the guide'. The description adds no additional meaning beyond the schema, meeting baseline for high coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'generate' and the resource 'internal linking suggestions for a guide', making the purpose understandable. However, it does not differentiate from sibling tools like 'get_internal_links' or 'update_guide', so no explicit sibling distinction.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when internal linking suggestions are needed, but lacks explicit when-to-use, when-not-to-use, or alternative guidance. The token cost note provides some context, but no exclusion criteria.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
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.
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.
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.
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.