Fetch GraphQL documentation for a given API element within the H3 GraphQL schema.
This tool provides documentation about GraphQL types, queries, mutations, fields, and enums.
Use it to explore the H3 GraphQL API and understand available queries and their parameters.
Args:
id (str): The API element ID to fetch documentation for. This can be:
- A type name (e.g., "Query", "Mutation", "Weakness")
- A field path (e.g., "Query.pentests_page", "Mutation.run_pentest")
- An enum type (e.g., "AuthzRole", "PortalOpState")
- An enum value (e.g., "AuthzRole.ORG_ADMIN", "PortalOpState.running")
Returns:
Dict with command output and status. The output field contains the
documentation from the GraphQL server. The GraphQL type of the result
is GQLAPIDoc.
Examples:
To explore all available queries:
fetch_graphql_docs("Query")
To get details about a specific query:
fetch_graphql_docs("Query.pentests_page")
To learn about a specific type:
fetch_graphql_docs("Weakness")
To explore available enum values:
fetch_graphql_docs("PortalOpState")
Tips:
1. Start with "Query" or "Mutation" to discover available operations
2. When you find a query of interest, get its detailed docs using "Query.<query_name>"
3. For any type mentioned in responses, get its details using the type name directly