HelpMyAgent

Describe a HelpMyAgent API

describe_api

Read-onlyIdempotent

Inspect metadata for one published HelpMyAgent endpoint without executing or charging for it. Returns the exact method, executable URL, input/output schemas, price, coverage, provenance, examples and documentation for a canonical endpoint slug.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`endpoint`	Yes	Canonical published HelpMyAgent endpoint slug. Accepted values are restricted to the live published catalogue.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedSep 19, 2026

changedInput schema / properties / endpoint / enum

Previous value: -[
-  "company/fr/aids",
-  "company/fr/benchmark",
-  "company/fr/certifications",
-  "company/fr/changes",
-  "company/fr/closures",
-  "company/fr/compare",
-  "company/fr/competitors",
-  "company/fr/compliance",
-  "company/fr/default-score",
-  "company/fr/director-mandates",
-  "company/fr/directors",
-  "company/fr/e-invoice",
-  "company/fr/establishments",
-  "company/fr/events",
-  "company/fr/financials",
-  "company/fr/history",
-  "company/fr/industrial-risk",
-  "company/fr/intelligence",
-  "company/fr/invoice-check",
-  "company/fr/kyb",
-  "company/fr/kyb-batch",
-  "company/fr/legal-announcements-search",
-  "company/fr/legal-announcements-since",
-  "company/fr/lobbying",
-  "company/fr/nearby",
-  "company/fr/new",
-  "company/fr/opportunities",
-  "company/fr/payment-context",
-  "company/fr/peers",
-  "company/fr/profile",
-  "company/fr/prospecting",
-  "company/fr/public-contract-competitors",
-  "company/fr/public-contracts",
-  "company/fr/public-contracts-eu",
-  "company/fr/regulator-alerts",
-  "company/fr/regulatory-approvals",
-  "company/fr/report",
-  "company/fr/risk",
-  "company/fr/risk-reading",
-  "company/fr/search",
-  "company/fr/sector-statistics",
-  "company/fr/signals",
-  "company/fr/successions",
-  "company/fr/supplier-verification",
-  "company/fr/verify",
-  "compliance/name-screen",
-  "iban/validate",
-  "procurement/fr/awards",
-  "procurement/fr/buyer-profile",
-  "procurement/fr/deadlines",
-  "procurement/fr/market",
-  "procurement/fr/search",
-  "procurement/fr/trends",
-  "vat/eu/validate"
-]New value: +[
+  "company/fr/aids",
+  "company/fr/benchmark",
+  "company/fr/certifications",
+  "company/fr/changes",
+  "company/fr/closures",
+  "company/fr/compare",
+  "company/fr/compliance",
+  "company/fr/default-score",
+  "company/fr/director-mandates",
+  "company/fr/directors",
+  "company/fr/e-invoice",
+  "company/fr/establishments",
+  "company/fr/events",
+  "company/fr/financials",
+  "company/fr/history",
+  "company/fr/industrial-risk",
+  "company/fr/intelligence",
+  "company/fr/invoice-check",
+  "company/fr/kyb-batch",
+  "company/fr/legal-announcements-search",
+  "company/fr/lobbying",
+  "company/fr/nearby",
+  "company/fr/new",
+  "company/fr/opportunities",
+  "company/fr/payment-context",
+  "company/fr/peers",
+  "company/fr/profile",
+  "company/fr/prospecting",
+  "company/fr/public-contract-competitors",
+  "company/fr/public-contracts",
+  "company/fr/public-contracts-eu",
+  "company/fr/regulatory-approvals",
+  "company/fr/report",
+  "company/fr/risk",
+  "company/fr/risk-reading",
+  "company/fr/search",
+  "company/fr/sector-statistics",
+  "company/fr/signals",
+  "company/fr/successions",
+  "company/fr/supplier-verification",
+  "company/fr/verify",
+  "compliance/name-screen",
+  "iban/validate",
+  "procurement/fr/awards",
+  "procurement/fr/buyer-profile",
+  "procurement/fr/deadlines",
+  "procurement/fr/market",
+  "procurement/fr/search",
+  "procurement/fr/trends",
+  "vat/eu/validate"
+]

Changed1 schema field changedSep 9, 2026

changedInput schema / properties / endpoint / enum

Previous value: -[
-  "company/fr/aids",
-  "company/fr/benchmark",
-  "company/fr/certifications",
-  "company/fr/changes",
-  "company/fr/closures",
-  "company/fr/compare",
-  "company/fr/competitors",
-  "company/fr/compliance",
-  "company/fr/default-score",
-  "company/fr/director-mandates",
-  "company/fr/directors",
-  "company/fr/e-invoice",
-  "company/fr/establishments",
-  "company/fr/events",
-  "company/fr/financials",
-  "company/fr/history",
-  "company/fr/industrial-risk",
-  "company/fr/intelligence",
-  "company/fr/invoice-check",
-  "company/fr/kyb",
-  "company/fr/kyb-batch",
-  "company/fr/legal-announcements-search",
-  "company/fr/legal-announcements-since",
-  "company/fr/lobbying",
-  "company/fr/nearby",
-  "company/fr/new",
-  "company/fr/opportunities",
-  "company/fr/payment-context",
-  "company/fr/peers",
-  "company/fr/profile",
-  "company/fr/prospecting",
-  "company/fr/public-contract-competitors",
-  "company/fr/public-contracts",
-  "company/fr/public-contracts-eu",
-  "company/fr/regulator-alerts",
-  "company/fr/regulatory-approvals",
-  "company/fr/report",
-  "company/fr/risk",
-  "company/fr/risk-reading",
-  "company/fr/search",
-  "company/fr/sector-statistics",
-  "company/fr/signals",
-  "company/fr/successions",
-  "company/fr/supplier-verification",
-  "company/fr/verify",
-  "compliance/name-screen",
-  "iban/validate",
-  "procurement/fr/buyer-profile",
-  "procurement/fr/deadlines",
-  "procurement/fr/search",
-  "vat/eu/validate"
-]New value: +[
+  "company/fr/aids",
+  "company/fr/benchmark",
+  "company/fr/certifications",
+  "company/fr/changes",
+  "company/fr/closures",
+  "company/fr/compare",
+  "company/fr/competitors",
+  "company/fr/compliance",
+  "company/fr/default-score",
+  "company/fr/director-mandates",
+  "company/fr/directors",
+  "company/fr/e-invoice",
+  "company/fr/establishments",
+  "company/fr/events",
+  "company/fr/financials",
+  "company/fr/history",
+  "company/fr/industrial-risk",
+  "company/fr/intelligence",
+  "company/fr/invoice-check",
+  "company/fr/kyb",
+  "company/fr/kyb-batch",
+  "company/fr/legal-announcements-search",
+  "company/fr/legal-announcements-since",
+  "company/fr/lobbying",
+  "company/fr/nearby",
+  "company/fr/new",
+  "company/fr/opportunities",
+  "company/fr/payment-context",
+  "company/fr/peers",
+  "company/fr/profile",
+  "company/fr/prospecting",
+  "company/fr/public-contract-competitors",
+  "company/fr/public-contracts",
+  "company/fr/public-contracts-eu",
+  "company/fr/regulator-alerts",
+  "company/fr/regulatory-approvals",
+  "company/fr/report",
+  "company/fr/risk",
+  "company/fr/risk-reading",
+  "company/fr/search",
+  "company/fr/sector-statistics",
+  "company/fr/signals",
+  "company/fr/successions",
+  "company/fr/supplier-verification",
+  "company/fr/verify",
+  "compliance/name-screen",
+  "iban/validate",
+  "procurement/fr/awards",
+  "procurement/fr/buyer-profile",
+  "procurement/fr/deadlines",
+  "procurement/fr/market",
+  "procurement/fr/search",
+  "procurement/fr/trends",
+  "vat/eu/validate"
+]

Changed1 schema field changedSep 9, 2026

changedInput schema / properties / endpoint / enum

Previous value: -[
-  "company/fr/aids",
-  "company/fr/benchmark",
-  "company/fr/certifications",
-  "company/fr/compare",
-  "company/fr/competitors",
-  "company/fr/compliance",
-  "company/fr/default-score",
-  "company/fr/director-mandates",
-  "company/fr/directors",
-  "company/fr/e-invoice",
-  "company/fr/events",
-  "company/fr/financials",
-  "company/fr/industrial-risk",
-  "company/fr/intelligence",
-  "company/fr/invoice-check",
-  "company/fr/kyb",
-  "company/fr/kyb-batch",
-  "company/fr/legal-announcements-search",
-  "company/fr/legal-announcements-since",
-  "company/fr/lobbying",
-  "company/fr/nearby",
-  "company/fr/opportunities",
-  "company/fr/payment-context",
-  "company/fr/peers",
-  "company/fr/profile",
-  "company/fr/prospecting",
-  "company/fr/public-contract-competitors",
-  "company/fr/public-contracts",
-  "company/fr/public-contracts-eu",
-  "company/fr/regulator-alerts",
-  "company/fr/regulatory-approvals",
-  "company/fr/report",
-  "company/fr/risk",
-  "company/fr/risk-reading",
-  "company/fr/search",
-  "company/fr/sector-statistics",
-  "company/fr/signals",
-  "company/fr/supplier-verification",
-  "company/fr/verify",
-  "compliance/name-screen",
-  "iban/validate",
-  "procurement/fr/buyer-profile",
-  "procurement/fr/deadlines",
-  "procurement/fr/search",
-  "vat/eu/validate"
-]New value: +[
+  "company/fr/aids",
+  "company/fr/benchmark",
+  "company/fr/certifications",
+  "company/fr/changes",
+  "company/fr/closures",
+  "company/fr/compare",
+  "company/fr/competitors",
+  "company/fr/compliance",
+  "company/fr/default-score",
+  "company/fr/director-mandates",
+  "company/fr/directors",
+  "company/fr/e-invoice",
+  "company/fr/establishments",
+  "company/fr/events",
+  "company/fr/financials",
+  "company/fr/history",
+  "company/fr/industrial-risk",
+  "company/fr/intelligence",
+  "company/fr/invoice-check",
+  "company/fr/kyb",
+  "company/fr/kyb-batch",
+  "company/fr/legal-announcements-search",
+  "company/fr/legal-announcements-since",
+  "company/fr/lobbying",
+  "company/fr/nearby",
+  "company/fr/new",
+  "company/fr/opportunities",
+  "company/fr/payment-context",
+  "company/fr/peers",
+  "company/fr/profile",
+  "company/fr/prospecting",
+  "company/fr/public-contract-competitors",
+  "company/fr/public-contracts",
+  "company/fr/public-contracts-eu",
+  "company/fr/regulator-alerts",
+  "company/fr/regulatory-approvals",
+  "company/fr/report",
+  "company/fr/risk",
+  "company/fr/risk-reading",
+  "company/fr/search",
+  "company/fr/sector-statistics",
+  "company/fr/signals",
+  "company/fr/successions",
+  "company/fr/supplier-verification",
+  "company/fr/verify",
+  "compliance/name-screen",
+  "iban/validate",
+  "procurement/fr/buyer-profile",
+  "procurement/fr/deadlines",
+  "procurement/fr/search",
+  "vat/eu/validate"
+]

Changed2 schema fields changedSep 8, 2026

changedInput schema / properties / endpoint / description

Previous value: -"Canonical published endpoint slug such as company/fr/profile. Hostnames, API version prefixes, query strings and leading slashes are not accepted."New value: +"Canonical published HelpMyAgent endpoint slug. Accepted values are restricted to the live published catalogue."

addedInput schema / properties / endpoint / enum

Added value: +[
+  "company/fr/aids",
+  "company/fr/benchmark",
+  "company/fr/certifications",
+  "company/fr/compare",
+  "company/fr/competitors",
+  "company/fr/compliance",
+  "company/fr/default-score",
+  "company/fr/director-mandates",
+  "company/fr/directors",
+  "company/fr/e-invoice",
+  "company/fr/events",
+  "company/fr/financials",
+  "company/fr/industrial-risk",
+  "company/fr/intelligence",
+  "company/fr/invoice-check",
+  "company/fr/kyb",
+  "company/fr/kyb-batch",
+  "company/fr/legal-announcements-search",
+  "company/fr/legal-announcements-since",
+  "company/fr/lobbying",
+  "company/fr/nearby",
+  "company/fr/opportunities",
+  "company/fr/payment-context",
+  "company/fr/peers",
+  "company/fr/profile",
+  "company/fr/prospecting",
+  "company/fr/public-contract-competitors",
+  "company/fr/public-contracts",
+  "company/fr/public-contracts-eu",
+  "company/fr/regulator-alerts",
+  "company/fr/regulatory-approvals",
+  "company/fr/report",
+  "company/fr/risk",
+  "company/fr/risk-reading",
+  "company/fr/search",
+  "company/fr/sector-statistics",
+  "company/fr/signals",
+  "company/fr/supplier-verification",
+  "company/fr/verify",
+  "compliance/name-screen",
+  "iban/validate",
+  "procurement/fr/buyer-profile",
+  "procurement/fr/deadlines",
+  "procurement/fr/search",
+  "vat/eu/validate"
+]

Changed3 schema fields changedSep 8, 2026

changedInput schema / properties / endpoint / description

Previous value: -"Canonical endpoint slug exactly as returned by search_apis, for example company/fr/profile. Do not include a hostname, API version prefix, query string or leading slash."New value: +"Canonical published endpoint slug such as company/fr/profile. Hostnames, API version prefixes, query strings and leading slashes are not accepted."

addedInput schema / properties / endpoint / maxLength
```
Added value: +128
```

addedInput schema / properties / endpoint / pattern

Added value: +"^[a-z0-9]+(?:/[a-z0-9][a-z0-9_-]*)+$"

Changed1 schema field changedSep 7, 2026

changedInput schema / properties / endpoint / description

Previous value: -"Canonical endpoint without version, exactly as published in the HelpMyAgent API catalogue."New value: +"Canonical endpoint slug exactly as returned by search_apis, for example company/fr/profile. Do not include a hostname, API version prefix, query string or leading slash."

First observedSep 6, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already establish readOnly, idempotent, and non-destructive behavior, so the description adds meaningful context by stating that no execution or charge occurs. It also discloses exactly what the response covers — method, URL, schemas, price, coverage, provenance, examples, documentation — which goes beyond the annotations and clarifies the tool's observable 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?

The description is one dense, well-structured sentence that front-loads the core purpose and then lists the returned metadata in a readable sequence. Every clause contributes useful information, and there is no filler or redundant repetition of the tool name or title.

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?

Given the single-parameter schema, rich annotations, and presence of an output schema, the description is fully sufficient for an agent to select and invoke the tool correctly. It clarifies the non-executing, non-charging behavior and enumerates the returned metadata, leaving no critical operational gap.

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 schema fully documents the single parameter with a description, enum of accepted values, and pattern, so the description does not need to add much. It restates the notion of a 'canonical endpoint slug' but does not materially enhance the parameter semantics beyond what the schema already provides.

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 names a specific verb ('Inspect'), a specific resource ('metadata for one published HelpMyAgent endpoint'), and explicitly distinguishes this from execution by saying 'without executing or charging for it.' It also enumerates the concrete metadata returned, making the tool's role unmistakable and distinct from the many data-returning sibling tools.

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?

The description clearly conveys that this tool is for inspecting metadata rather than invoking an API, and that it requires a 'canonical endpoint slug.' It does not explicitly mention alternatives like search_apis or list_categories for discovery, but the 'without executing or charging' qualifier provides clear practical guidance on when to choose this tool.

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

All HelpMyAgent 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?