zabbix-graphql-api/docs/howtos/README.md
Andreas Hilbig 91a1523d71 docs: complete documentation refactoring and structure optimization
This commit finalizes the documentation improvement plan by:
- Centralizing reference material in README.md.
- Creating a dedicated Technical Maintenance guide (docs/howtos/maintenance.md).
- Creating a categorized Sample Queries & Mutations overview (docs/queries/README.md).
- Eliminating redundant information across the doc set (DRY principle).
- Optimizing cross-references between reference documentation and the Cookbook.
- Updating the improvement plan to reflect all tasks as completed.
2026-01-30 15:08:19 +01:00

1.4 KiB

How-To Guides

This directory contains detailed guides on how to use and extend the Zabbix GraphQL API.

Available Guides

🍳 Cookbook

Practical, step-by-step recipes for common tasks, designed for both humans and AI-based test generation.

📊 Schema and Schema Extension

Learn about the GraphQL schema structure, how Zabbix entities map to GraphQL types, and how to use the dynamic schema extension system.

🗂️ Hierarchical Data Mapping

Understand how the API automatically maps flat Zabbix item keys into nested GraphQL objects using hierarchical resolvers and type hinting.

🔐 Roles and Permissions Extension

Discover how the permission system works, how to define permission levels using Zabbix template groups, and how to query user permissions.

🛠️ Technical Maintenance

Guide on code generation (GraphQL Codegen), running Jest tests, and local Docker builds.

🤖 MCP & Agent Integration

Discover how to integrate with the Model Context Protocol (MCP) to enable LLMs and autonomous agents to interact with Zabbix efficiently.


🔍 Additional Resources

  • Sample Queries: Categorized list of practical GraphQL operation examples.
  • Main README: Technical reference, configuration, and environment setup.