Skip to content

docs: add FAQ section for common questions#3

Open
meichuanyi wants to merge 1 commit into
kingler:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: add FAQ section for common questions#3
meichuanyi wants to merge 1 commit into
kingler:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi

@meichuanyi meichuanyi commented May 10, 2026

Copy link
Copy Markdown

Summary

Adds a comprehensive FAQ section to help users understand and use the n8n workflow vectorization and knowledge graph project.

Changes

  • Added FAQ section covering:
    • General (what is n8n_agent, MCP integrations)
    • Setup & Installation (process workflows, configure env vars)
    • MCP Integrations (QDRANT, n8n, Workflow Validation)
    • Workflow Analysis (extracted info, validation categories)
    • Database Integration (QDRANT, Neo4j, Supabase)
    • Troubleshooting (connection issues, validation failures, help resources)

Benefits

  • New users can quickly understand the project
  • Clear instructions for each MCP integration
  • Self-service troubleshooting for common issues

Testing

  • FAQ content aligns with existing README
  • Markdown formatting validated locally

Pure documentation improvement, no code changes.

Summary by Sourcery

Add a comprehensive FAQ section to the README to answer common questions about using and integrating the project.

Documentation:

  • Document general concepts of n8n_agent and MCP integrations in a new FAQ section.
  • Add setup, environment configuration, and workflow processing guidance to the README FAQ.
  • Describe MCP usage for QDRANT, n8n, and workflow validation through FAQ entries.
  • Explain workflow analysis outputs and validation categories in the FAQ.
  • Highlight database roles for QDRANT, Neo4j, and Supabase, plus troubleshooting tips for common connection and validation issues.

@sourcery-ai

sourcery-ai Bot commented May 10, 2026

Copy link
Copy Markdown

Reviewer's Guide

Adds a new FAQ section to the README to document common questions about n8n_agent, its MCP-based integrations, workflow analysis, database backends, and troubleshooting steps, without modifying any runtime code.

File-Level Changes

Change Details Files
Document a comprehensive FAQ section in the README covering usage, integrations, analysis features, and troubleshooting.
  • Append a new "Frequently Asked Questions (FAQ)" section after the roadmap in the README.
  • Describe the overall purpose of n8n_agent and its use of Qdrant, Neo4j, and Supabase.
  • Explain MCP integrations for n8n, Qdrant, Supabase, and workflow validation, including available MCP tools and commands.
  • Provide setup and installation guidance such as running the workflow parser and configuring required environment variables.
  • Detail what data is extracted during workflow analysis and which validation categories exist.
  • Clarify the roles of each database integration (vector, graph, relational) and their current implementation status.
  • Add troubleshooting guidance for common connectivity and validation issues, plus where to get additional help.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Consider aligning terminology and capitalization throughout the FAQ (e.g., QDRANT vs Qdrant, n8n_agent vs n8n agent, MCP tool names) with the rest of the README and actual CLI/tool identifiers to avoid confusion.
  • Some FAQ answers repeat content already described above (e.g., workflow analysis details, validation categories); you might instead link back to the relevant sections to keep the README shorter and avoid having to maintain the same information in two places.
  • For items marked as "(Currently in development)" in the database integration section, clarify the current level of support or expected behavior so readers know whether these are safe to use or still experimental.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider aligning terminology and capitalization throughout the FAQ (e.g., `QDRANT` vs `Qdrant`, `n8n_agent` vs `n8n agent`, MCP tool names) with the rest of the README and actual CLI/tool identifiers to avoid confusion.
- Some FAQ answers repeat content already described above (e.g., workflow analysis details, validation categories); you might instead link back to the relevant sections to keep the README shorter and avoid having to maintain the same information in two places.
- For items marked as "(Currently in development)" in the database integration section, clarify the current level of support or expected behavior so readers know whether these are safe to use or still experimental.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant