Skip to main content
Glama
Sign In

APIVerve

by com.apiverve
OverviewDiscussionsAdmin

HTML Entities Encoder/Decoder

HTMLEntitiesEncoderDecoder
Read-only

HTML Entities Encoder/Decoder: HTML Entities Encoder/Decoder converts special characters into safe HTML entities or restores encoded strings back to standard text. Pass any HTML markup or text snippet to receive the converted string, a replacement count, and a list of modified characters. (Cost: 1 credit)

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": {
      "html": "<html>"
    },
    "name": "HTMLEntitiesEncoderDecoder"
  }
}

Input Schema

NameRequiredDescriptionDefault
htmlYesThe HTML content to encode
actionNoThe action to performencode

Output Schema

NameRequiredDescriptionDefault
dataNo
errorNoError message, null on success
statusNo"ok" on success

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds genuinely new context: the response contains a replacement count and a list of modified characters, plus a 1-credit cost, but it does not explain default behavior (encode when action is omitted) or limits on input size.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The opening repeats the title verbatim before the actual description ('HTML Entities Encoder/Decoder: HTML Entities Encoder/Decoder converts...'), wasting the most prominent position. The remaining sentences are reasonably tight, and the credit cost is placed at the end where it is easy to miss.

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

Completeness4/5

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

For a two-parameter, fully documented, read-only utility with an output schema, the description covers what it does, what it returns, and what it costs. The only meaningful gap is not telling the agent how the encode/decode direction is selected.

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 description coverage is 100%, so both parameters are already documented, and the description only loosely restates the 'html' input. It never mentions the 'action' parameter or its accepted values, so the description does not clarify how to switch between encoding and decoding.

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?

The description names a specific resource (HTML entities / special characters) and both directions of the operation (convert to entities or restore back to text). However, it does not distinguish itself from similar siblings such as HTMLtoText, URLEncoderDecoder, or UnicodeEscapeUnescape, so an agent must infer the boundary itself.

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 only implied by 'Pass any HTML markup or text snippet', which suggests the input type but never states when to choose this over the many related encoding/conversion siblings. There are no exclusions or alternative-tool routing.

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

All APIVerve toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources