Have I Been Pwned

Have I Been Pwned - Subscription Status

hibp_get_subscription_status

Read-onlyIdempotent

Return the current plan, quotas, rate limits, expiry, and feature flags for the active HIBP API subscription linked to the authenticated OAuth connection. Use it to confirm access before feature-dependent lookups.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`response_format`	No	Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.	markdown

Output Schema

TableJSON Schema

Name	Required	Description
`message`	No	Present when the tool returns an error.
`guidance`	No	Additional guidance for resolving the tool error.
`statusCode`	No	Present when the tool returns an error.
`subscription`	No
`rateLimitResetAt`	No	UTC timestamp indicating when the current rate limit window should have reset.
`retryAfterHeaders`	No	Retry headers that mirror the standard HTTP rate-limit response when applicable.
`retryAfterSeconds`	No	How long to wait before retrying, when the tool is rate limited.

Schema Changelog

Changes observed during successful MCP inspections.

Changed15 schema fields changedAug 27, 2026

changedInput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

changedInput schema / properties / response_format / description

Previous value: -"Format the text response as markdown (default) or JSON. structuredContent is always returned."New value: +"Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent."

changedOutput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

addedOutput schema / properties / subscription / properties / Description / description
```
Added value: +"Current HIBP API subscription plan description."
```
addedOutput schema / properties / subscription / properties / DomainSearchMaxBreachedAccounts / description
```
Added value: +"Maximum breached accounts returned by a domain search, when applicable."
```
addedOutput schema / properties / subscription / properties / IncludesAutoSubdomainVerification / description
```
Added value: +"Whether the subscription includes automatic subdomain verification."
```
addedOutput schema / properties / subscription / properties / IncludesBulkDomainAdd / description
```
Added value: +"Whether the subscription includes bulk domain addition."
```
addedOutput schema / properties / subscription / properties / IncludesCustomerDomains / description
```
Added value: +"Whether the subscription includes customer-domain support."
```

addedOutput schema / properties / subscription / properties / IncludesKAnon / description

Added value: +"Whether the subscription includes breached-account k-anonymity range lookups."

addedOutput schema / properties / subscription / properties / IncludesStealerLogs / description
```
Added value: +"Whether the subscription includes stealer-log lookups."
```

addedOutput schema / properties / subscription / properties / KAnonRpm / description

Added value: +"Maximum breached-account k-anonymity range lookups per minute, when included."

addedOutput schema / properties / subscription / properties / MaxBreachedDomains / description
```
Added value: +"Maximum verified domains allowed by the subscription, when applicable."
```
addedOutput schema / properties / subscription / properties / Rpm / description
```
Added value: +"Maximum API requests per minute for the subscription."
```
addedOutput schema / properties / subscription / properties / SubscribedUntil / description
```
Added value: +"UTC timestamp when the current subscription expires."
```
addedOutput schema / properties / subscription / properties / SubscriptionName / description
```
Added value: +"Current HIBP API subscription plan name."
```

First observedJul 23, 2026

TDQS

A4.3/5.0

Behavior4/5

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

The description adds meaningful details beyond the annotations (which already declare read-only, idempotent, non-destructive): it lists the exact data returned and mentions the authenticated OAuth connection. This gives the agent a clear picture of what the call will produce, though it doesn't discuss potential errors or rate-limit behavior.

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 sentences, no wasted words. The primary purpose is stated first, followed by a practical use case. The description is well-structured and front-loaded with essential information.

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 simple read-only status check with one optional parameter and an output schema, the description is complete. It specifies what data is returned, why to use it, and mentions the authentication context. No missing information that an agent would need to invoke it correctly.

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 only parameter, response_format, is fully described in the schema (enum, default, description) with 100% coverage. The description adds no extra parameter semantics, which is acceptable since the schema already carries the load. Baseline of 3 is appropriate.

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?

The description clearly states the tool returns the current plan, quotas, rate limits, expiry, and feature flags for the active HIBP API subscription. This is a specific verb and resource that distinguishes it from all sibling tools, none of which appear to handle subscription status.

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?

Explicitly provides a use case: 'Use it to confirm access before feature-dependent lookups.' While it doesn't mention exclusions or alternatives, the tool is unique among siblings, so the context is clear. Could be improved by stating when it's not needed, but the guidance is strong.

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

All Have I Been Pwned tools Inspect

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

Need Help?