Tools
Exactly what the server advertised in the scan completed . Effects and capabilities are classified by Squatch from each tool's metadata. Squatch never runs tools. Compared with the previous scan: 1 new, 3 changed.
- Effect: Read 39
- Effect: Write 20
- Effect: Delete 2
- Effect: Admin 2
- Effect: Unknown effect 8
Showing 71 of 71 tools
| Details | ||
|---|---|---|
| remove_company Removes the company from the list (owner or admin); the organization and the PDFs stay, and adding the CNPJ again brings it back. | Effect: Admin | |
| rotate_webhook_secret Changes the secret that signs the webhooks (requires the token edm_…). The previous secret still signs for 24 h, so you can change it witho… | Effect: Admin | |
| remove_company_document Removes a proof from your own company; the analyses that used it become out of date. | Effect: Delete | |
| remove_saved Removes the procurement from the personal list of the owner. Saving does not create a watch or a notification. The client sends only the ID… | Effect: Delete | |
| account_tracking Checks that the Salvas, Alertas and Vigias belong to the account of the session. The lists of a guest edm_… move to the account with `POST … | Effect: Write | |
| add_company Imports the CNPJ into a new organization or into the organization of the organization key. Without X-Organization-Id, it creates the organi… | Effect: Write | |
| analyze_participation Starts or resumes the analysis with the company record, the attachments and the tender. Call it only when the user asks; follow it with get… | Effect: Write | |
| api_access_buyChanged Buy 1000 basic data reads for US$0.10, valid for 30 days. Same pass in retries recovers the same purchase. No automatic renewal. OCR, AI, d… | Effect: Write | |
| api_index The EditalMD API index, with the routes. | Effect: Write | |
| attach_company_document Sends a PDF proof of the company. It does not start OCR. Requires a session; for large files, prefer HTTP. Returns 201. JSON up to 11,200,0… | Effect: Write | |
| buy_plan Buys a plan for the account or paying wallet. Pix and USDC pay 30 days with no automatic renewal; the card subscribes monthly and renews un… | Effect: Write | |
| cancel_plan Cancels the active plan: nothing else is charged, and what you paid for stays active until the end of its period. Send `{ "accept_data_remo… | Effect: Write | |
| claim_guest_tracking Brings into the session account what the guest edm_… created (the SDK claim): the Salvas, Alertas and Vigias that the account does not have… | Effect: Write | |
| create_alert An alert for new procurements by object terms and state (UF). Use the account session or guest token. Channels: pull, signed webhook or ema… | Effect: Write | |
| create_alerts_by_cnpj Alerts for new procurements by the company CNPJ (requires the token edm_…): the activities (CNAE) become families of terms, and there is on… | Effect: Write | |
| create_owner Creates the guest (token edm_…, issued by the account library) that opens alerts and watches, and the secret whsec_… that signs the webhook… | Effect: Write | |
| criar_cobranca Reserves an exclusive address/QR to buy your access with USDC on Base. Check GET /geracao and send cotacao. Each buyer pays, even when the … | Effect: Write | |
| documento_vincular Links your anonymous purchase to the authenticated account, without a new charge. Requires a session and private proof of the purchase. It … | Effect: Write | |
| evaluation_basic_result Follows the basic reading after retry_after_s and returns the text per page with the hash of the source. Allowance per credential, until th… | Effect: Write | |
| generation_status Follows the real phases and the completion, free, without starting processing. | Effect: Write | |
| gerar_markdown Buys individual access to the document for US$ 0.02/page, through x402/credit. Each buyer pays, even when the text is ready. Check GET or t… | Effect: Write | |
| request_original When the person wants the document, downloads the pending original from PNCP now. Free and idempotent. It does not start OCR. Use it when t… | Effect: Write | |
| save_procurement Saves the procurement, up to 200 per owner. Saving does not create a watch or a notification. The client sends only the ID; the snapshot co… | Effect: Write | |
| update_alert Edits the interest, or pauses or turns on again an alert of the owner. The filters replace the whole filter. | Effect: Write | |
| api_access Discover the monthly data package or inspect a private purchase. Returns: { offer{id,price_usd,credits,days,auto_renew,unit,products,purcha… | Effect: Read | |
| awarded_prices The price that wins for a similar item, as a free summary: how many prices, the median and the range (p25/p75) of the same catalog product … | Effect: Read | |
| company_documents Lists the private PDFs of the company. Binary downloads use the authenticated HTTP GET /documentos/:arquivo. | Effect: Read | |
| credito_saldoChanged Balance and statement with cred_…; wallet balance and up to 20 payments being recovered with mmw_…. A request without a token receives 401.… | Effect: Read | |
| documento_acesso Checks the link and allows exporting the code of a purchase that is still anonymous. Returns: { documento_id, vinculado, recuperacao } | Effect: Read | |
| estado_cobranca Reads the address, confirmation, receipt and release of your charge, free of charge. Reuse X-Cobranca and respect Retry-After. The lookup d… | Effect: Read | |
| framework_agreements The valid framework agreements (`ata de registro de preços`) on PNCP for the object, most relevant first: the managing agency, the validity… | Effect: Read | |
| get_api_x402_precos The short winning price for an agent, paid per call, with no account: the full summary and up to 10 items. Collecting procurement items and… | Effect: Read | |
| get_deadlines The deadlines of the procurement: the published end of proposals and the last day to challenge the tender (estimate: 3 business days before… | Effect: Read | |
| get_document A free lookup of the title, type, pages and the procurement linked to a document. Use `get_procurement` to list the related documents. It d… | Effect: Read | |
| get_document_dossier Items, requirements, attestations, deadlines and obligations, with conditions, exceptions and excerpts/pages. It uses the same acesso_codig… | Effect: Read | |
| get_owner The owner state (requires the token edm_… or the account session): account or guest, the notice e-mail, the allowance and the secret whsec_… | Effect: Read | |
| get_participation Reads the state, the pending items and the met items, with reasons, actions and evidence. It never starts an analysis. Pending items group … | Effect: Read | |
| get_procurement The procurement record and its documents in the collection (up to 50), with titles, types, pages and availability. Free. Served from the ed… | Effect: Read | |
| get_qualification The qualification list of the tender, with literal excerpts: conditions, exceptions and evidence by page of the available analysis. The loo… | Effect: Read | |
| get_reading_manifest The document manifest: pages, images, SHA-256 and version. Send acesso_codigo; the examples are free. It does not start OCR. The same autho… | Effect: Read | |
| get_tender_markdown Reads the Markdown with the acesso_codigo of the document, or with avaliacao_codigo and agent_pass of the sponsored premium. The examples a… | Effect: Read | |
| health Health of the origin and size of the collection (procurements and documents with text). | Effect: Read | |
| list_alert_matches The procurements that already matched an alert (pull channel), with deadlines and delivery status. Requires the token edm_…. | Effect: Read | |
| list_cnaes Search term suggestions by economic activity (CNAE), with the description, the family and coverage indicators. Free. Without `q`, it lists … | Effect: Read | |
| list_document_files The catalog of the original files of the document, with download links and pages. Use /api/documento/{id}/original to download the full ori… | Effect: Read | |
| list_examples Lists real free proofs to check the Markdown, the original PDF and the ZIP with images before you generate another document. | Effect: Read | |
| list_my_companies The companies are the account organizations with EditalMD; use the session or the organization key. | Effect: Read | |
| list_plans The plans for sale and the authenticated account or wallet's active plan. Pix and USDC pay 30 days with no automatic renewal; the card subs… | Effect: Read | |
| list_saved Lists up to 200 tenders saved by the owner, free. | Effect: Read | |
| list_watch_events The events of a watched procurement (what changed, from what to what, and when) and the current snapshot. Requires the token edm_…. | Effect: Read | |
| lookup_reference Search municipality names, activities and other Radar CNPJ reference data. Returns: { ok, results } | Effect: Read | |
| open_tenders_in_field The tenders with an open proposal period published in the last 7 days, in the state (UF) and in the CNAEs of the companies that supply the … | Effect: Read | |
| original_status Reads the status of the original, free. It does not ask for a download or a generation. It returns only the file status: it does not delive… | Effect: Read | |
| preview_alert A free sample of procurements by terms and filters, or editable suggestions by CNPJ. It does not create alerts. | Effect: Read | |
| procurement_catalogNew Public navigation of the collection by modality, state, date and municipality. We prepare procurement summaries and supplier rankings from … | Effect: Read | |
| procurement_plans What agencies plan to procure (annual procurement plans, PCA, on PNCP), before the tender opens: item, agency, quantity, estimated value an… | Effect: Read | |
| recibo Receipt of a delivery: the proof of what was delivered, how much it cost and with which hash. Returns: { recibo{id,recurso,documento_id,pre… | Effect: Read | |
| search_companies Searches the company registry by CNPJ or company name; requires an account or a guest. | Effect: Read | |
| search_tenders Searches public procurements by term. Free. Returns the object, the agency, the state (UF), the modality and the procurement id. The procur… | Effect: Read | |
| select_company Selects a registered company; it does not run an analysis. Each person's choice is kept in the account. Repeating the current choice writes… | Effect: Read | |
| tenders_outside_pncp Tenders that agencies report to the state audit court, or publish on their own portal, and that are not on PNCP (today the TCE-RS LicitaCon… | Effect: Read | |
| watch_procurement Watches a procurement (requires the token edm_…): takes a snapshot now and records the events of correction, new document, suspension, post… | Effect: Read | |
| who_supplies The CNAEs (activity codes) that usually win procurements like this one, most likely first, with the official description and, per CNAE, how… | Effect: Read | |
| credito_recarregar Tops up prepaid credit: pay once with x402 and get the token that is charged in any API of the house. Returns: { token, saldo_usd, guarde, … | Effect: Unknown effect | |
| evaluation_basic Basic native or OCR text of a PDF of up to 50 pages / 32 MiB, without review or structured tables. Up to 100 documents per agent. It does n… | Effect: Unknown effect | |
| evaluation_premium Uses your only sponsored premium on a document of up to 50 pages. Keep evaluation.access_code as avaliacao_codigo and follow it with genera… | Effect: Unknown effect | |
| evaluation_quota Individual allowance: one premium and 100 basic documents, with an expiry date. | Effect: Unknown effect | |
| my_account The identity and the private counters of the account session (cookie) sent in the MCP request. The global account is already the person in … | Effect: Unknown effect | |
| my_documents The private collection of the account. Requires the account session (cookie and the browser CSRF). | Effect: Unknown effect | |
| my_procurements The private collection of the account. Requires the account session (cookie and the browser CSRF). | Effect: Unknown effect | |
| pricingChanged Current public prices, free allowances and payment discovery; does not create a charge. | Effect: Unknown effect |