Skip to main content

Introduction to the Syntasa Help Agent

Overview​

The Syntasa Help Agent is the default assistant available on dev-agents.syntasa.ai. It is designed to answer “How do I…?” questions about the Syntasa platform by searching public documentation and generating grounded, documentation-based responses.

The agent acts as an intelligent documentation assistant, helping users quickly understand platform concepts, configurations, workflows, and operational procedures without manually navigating large documentation sets.

What the Syntasa Help Agent Can Do​

The Help Agent is intended for users who want guidance on how to use various features of the Syntasa platform.

Typical use cases include:

  • Understanding how to perform tasks within the platform
  • Learning what specific features or configuration options mean
  • Discovering valid parameters and settings
  • Reviewing prerequisites for workflows or configurations
  • Receiving step-by-step instructions for common platform operations

Examples include:

  • Creating a connection
  • Configuring a process type
  • Scheduling a workflow
  • Setting up an event store
  • Understanding platform terminology and architecture

What the Help Agent Will Not Do​

The Help Agent is intentionally scoped to documentation-based support and platform guidance.

It will not:

  • Invent undocumented features or configuration parameters
  • Answer general programming or non-Syntasa questions
  • Disclose author names, file paths, or internal contact information
  • Read, modify, or interact with your actual apps, workflows, or connections

For operational troubleshooting or environment modifications, users should instead use specialized agents such as:

  • The Log Analysis Agent
  • The App Builder Agent

Key Benefits​

Faster Access to Documentation​

Instead of manually searching documentation, users can ask natural-language questions and receive targeted answers.

Grounded Responses​

The agent generates responses strictly from documented Syntasa knowledge sources, reducing the risk of unsupported guidance.

Improved Learning Experience​

Users can ask follow-up questions and progressively deepen their understanding of workflows, configuration models, and platform behavior.

Simplified Onboarding​

New users can quickly understand platform concepts without needing extensive prior familiarity with the documentation structure.

Typical Question Categories​

The Help Agent supports several categories of documentation-related questions.

Getting Started and Concepts​

Examples include:

  • What is a Syntasa app?
  • What does an event store do?
  • What templates are available for new apps?

Procedural “How-To” Questions​

Examples include:

  • How do I create a GCS connection?
  • How do I schedule a workflow to run nightly?
  • How do I configure an EVENT_LOADER node?

Configuration and Parameters​

Examples include:

  • What parameters does the GCS connection type accept?
  • What are valid values for specific configuration keys?

Conclusion​

The Syntasa Help Agent provides an efficient and reliable way to access platform knowledge through conversational interaction. By grounding responses in official documentation, it enables users to learn faster, configure features more accurately, and navigate the Syntasa platform more effectively.