Skip to main content
Glama

pushfa_read_installation_guide

Read-only

Read the current official Markdown setup guide to install or upgrade Pushfa for web, Android, or iOS projects. Use platform, offset, and revision parameters to load the needed section.

Instructions

Read the current official Markdown guide before installing or upgrading Pushfa in a Web Push, native Android, or native iOS project. The first page includes section offsets; continue with next_offset or jump to a section using the returned revision.

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": {
      "platform": "<platform>"
    },
    "name": "pushfa_read_installation_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
offsetNoOmit for the first page, or pass next_offset or a section offset from this guide.
platformYesUse web for websites and PWAs, including Web Push on iOS.
revisionNoRequired when reading from a nonzero offset. Use the returned revision.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.8/5.0
Behavior3/5

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

readOnlyHint=true already declares this as a safe read, so the description only needs to add operational context, which it does by revealing pagination behavior (section offsets, next_offset continuation) and that jumping to a section requires the returned revision. It does not mention caching, staleness, or whether revision mismatch causes an error — the state-change/error semantics an agent would want when paging a versioned document.

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

Conciseness5/5

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

Two front-loaded sentences: the first states purpose and timing, the second covers the pagination mechanics. Nothing is redundant or padding.

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?

With readOnlyHint covering safety, full schema coverage on three parameters, and no output schema, the description supplies what an agent needs to make a first call and continue paging. Only minor gaps remain, such as what a revision mismatch produces.

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 platform, offset, and revision are already documented in the schema, including the rule that revision is required for nonzero offsets. The description reinforces the offset/next_offset workflow but introduces no syntax or constraint beyond what the schema states; baseline 3 applies.

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 uses a specific verb and resource ("Read the current official Markdown guide") and names the concrete scenarios it serves (installing or upgrading Pushfa on Web Push, native Android, native iOS). It is unambiguous about what the tool returns, though with no siblings in context there is no alternative to differentiate against.

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

Usage Guidelines4/5

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

It gives explicit timing guidance — read this guide before installing or upgrading — and explains the follow-up flow (first page gives section offsets, then continue with next_offset or jump to a section). It stops short of stating any when-not-to-use conditions or what to do if the guide is unavailable.

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

Deploy Server

Other Tools