Skip to main content
Glama

Get Keyword Edit Allowance

keyword_change_usage
Read-onlyIdempotent

Reports monthly keyword-edit allowance (limit, used, remaining, unlimited) so clients can budget edit_keyword calls; it returns usage only and does not alter capacity or billing.

Instructions

Get the monthly keyword-edit allowance for the account as { limit, used, remaining, unlimited }, where limit -1 means unlimited. Only edit_keyword ever counted toward it; add_keywords, disable_keyword, and enable_keyword never did. Every current plan reports unlimited, so there is no need to check it before edit_keyword; it remains for clients that budget edits. This reports editing allowance only; it does not change keyword capacity, sell a plan, or initiate payment.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "keyword_change_usage"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspaceIdNoWorkspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv1.6.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / workspaceId
      Added value: +{
      +  "description": "Workspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another",
      +  "type": "string"
      +}
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedOutput schema / properties / result / additionalProperties
      Added value: +true
    • removedOutput schema / properties / result / description
      Removed value: -"{ limit, used, remaining, unlimited }; limit -1 and unlimited true mean edits are not metered."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "limit": {
      +    "description": "Edits allowed per month; -1 when unlimited",
      +    "type": "integer"
      +  },
      +  "remaining": {
      +    "description": "-1 when unlimited",
      +    "type": "integer"
      +  },
      +  "unlimited": {
      +    "type": "boolean"
      +  },
      +  "used": {
      +    "type": "integer"
      +  }
      +}
    • addedOutput schema / properties / result / required
      Added value: +[
      +  "limit",
      +  "used",
      +  "remaining",
      +  "unlimited"
      +]
    • addedOutput schema / properties / result / type
      Added value: +"object"
    • addedOutput schema / required
      Added value: +[
      +  "result"
      +]
  2. Changed1 schema field changedv0.1.1
    • changedOutput schema / properties / result / description
      Previous value: -"The monthly keyword-edit allowance limit and the amount used."New value: +"{ limit, used, remaining, unlimited }; limit -1 and unlimited true mean edits are not metered."
  3. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare a safe, idempotent read, and the description adds behavior beyond them: the -1 sentinel means unlimited, only edit_keyword historically decremented the counter, and every current plan reports unlimited. Those are non-obvious semantics an agent could not recover from the annotations or schema.

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?

Front-loaded with the purpose and return shape, then the counting rule, then the routing caveats. It is dense and every sentence carries information, though the closing negative list (capacity, plan, payment) is slightly broader than strictly needed.

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

Completeness5/5

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

For a one-parameter read tool with an output schema, the definition covers everything an agent needs: what it returns, what the sentinel means, when it is unnecessary, and which neighboring operations it must not be confused with.

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?

The single workspaceId is fully documented in the schema (100% coverage), including default-workspace fallback and id-crossing warnings, so the description adds nothing about parameters. Baseline 3 is appropriate when the schema does all the work.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Get the monthly keyword-edit allowance for the account") and immediately defines the return fields { limit, used, remaining, unlimited }. It is distinguishable from edit_keyword and the other keyword siblings by naming exactly which operations do and do not consume the allowance.

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

Usage Guidelines5/5

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

Explicitly tells the agent not to call it before edit_keyword ("there is no need to check it before edit_keyword") and states the only legitimate use case ("clients that budget edits"). It also rules out adjacent intents — capacity changes, plan sales, payments — so misrouting toward billing tools is prevented.

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