unpublish_reportRevert a published report (listed or unlisted) back to private visibility, removing it from the public catalog. Author-only. Idempotent.
| Name | Required | Description | Default |
|---|---|---|---|
| report_id | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| _meta | Yes | Provenance envelope — data lineage for every MCP response | |
| report | Yes |
Changes observed during successful MCP inspections.
Output schema / properties / _meta / properties / cost_usd / properties / basis / descriptionPrevious value: -"payg_charge = real charge (agent-pay or your balance). payg_rate_card = indicative price, not billed."New value: +"payg_charge = real pay-per-call charge (a card or MPP payment through agent-pay). payg_rate_card = indicative price, not billed."Output schema / properties / _meta / properties / cost_usd / properties / basis / descriptionPrevious value: -"payg_charge = real agent-pay charge. payg_rate_card = indicative price, not billed."New value: +"payg_charge = real charge (agent-pay or your balance). payg_rate_card = indicative price, not billed."Output schema / properties / _meta / properties / cost_usd / properties / billed / descriptionPrevious value: -"true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value; your plan already covers this call for free."New value: +"true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value only: no charge was made for this call (it was within your plan)."Output schema / properties / _meta / properties / fundamentals_as_of / descriptionPrevious value: -"ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt. Use THIS — not `last_updated` — when telling a user how current the fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to."New value: +"ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt in bulk. Use THIS — not `last_updated` — when telling a user how current the cross-sectional fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to. It is a floor for a single filer, not a ceiling: a filer with a live partition receives its filing, facts and ratios intraday (minutes after EDGAR dissemination), so an entity-scoped read may carry a filing newer than this; cross-sectional ranks (factor scores, earnings signals) refresh with the weekly bulk export."Output schema / properties / _meta / properties / fundamentals_as_ofAdded value: +{
+ "description": "ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt. Use THIS — not `last_updated` — when telling a user how current the fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to.",
+ "type": "string"
+}Output schema / properties / _meta / properties / price_as_ofAdded value: +{
+ "description": "ISO timestamp when the price surfaces were last refreshed.",
+ "type": "string"
+}Output schema / properties / _meta / properties / cost_usdAdded value: +{
+ "additionalProperties": false,
+ "description": "Per-call cost transparency. Omitted for subscription-only tools that have no PAYG-equivalent price.",
+ "properties": {
+ "amount_usd": {
+ "minimum": 0,
+ "type": "number"
+ },
+ "basis": {
+ "description": "payg_charge = real agent-pay charge. payg_rate_card = indicative price, not billed.",
+ "enum": [
+ "payg_charge",
+ "payg_rate_card"
+ ],
+ "type": "string"
+ },
+ "billed": {
+ "description": "true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value; your plan already covers this call for free.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "amount_usd",
+ "billed",
+ "basis"
+ ],
+ "type": "object"
+}Output schema / properties / _meta / properties / latency_msAdded value: +{
+ "description": "Wall-clock milliseconds this tool call took, measured server-side around the handler.",
+ "minimum": 0,
+ "type": "integer"
+}Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=true and readOnlyHint=false, so safety is covered. The description adds genuinely new context: an authorization constraint ('Author-only') and the concrete side effect ('removing it from the public catalog'), which tells the agent the report itself survives while its visibility drops. It does not say what happens if the report is already private or what error surfaces for non-authors.
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?
One main clause front-loads the state transition and effect, followed by two short qualifiers. Every element earns its place; 'Idempotent' mildly duplicates the annotation but is cheap.
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?
With an output schema present and rich annotations, the description only needs to carry auth, effect, and scope — which it does. The remaining gap is edge-case behavior (already-private reports, non-author callers, whether re-publishing restores the prior listed/unlisted state).
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?
The single parameter report_id has 0% schema description coverage, so the description carries the burden, yet it never mentions the identifier directly or its format/scope. 'A published report' implicitly points at the one required arg, which keeps it at minimum-viable rather than poor.
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?
States a specific verb (revert/unpublish) and resource (report), plus the exact state transition: published (listed or unlisted) -> private. It is trivially distinguishable from publish_report, unpublish_claim, unpublish_thesis, and delete_report by the resource and outcome named.
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 parenthetical '(listed or unlisted)' tells the agent this tool covers both published states, which is a real routing decision against publish_report. It gives clear context but no explicit exclusions, e.g. it never says to use delete_report when the report should be removed entirely rather than hidden.
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.