AgileBuilder logoAgileBuilder
Back to docs

Document System

Understand AgileBuilder's document system

Overview

AgileBuilder's document system lets you ingest team documentation and map it as resources in MCP for AI tools to query in real time. This means AI can generate code based on your team's standards instead of making things up.

Document System Architecture

Why a Document System

In the AI development era, teams typically face these challenges:

  • AI-generated code doesn't follow team conventions
  • Team agreements have to be repeated in every prompt
  • AI doesn't know project-specific requirements

With the document system, you can:

  • Document team standards
  • Let AI query team standards in real time
  • Ensure AI-generated code meets team standards

Document Ingestion

Ingest via Console

  1. Log in to AgileBuilder Console
  2. Go to the "Document Library" page
  3. Click "Add Document"

Add Document

Document Formats

Supported formats:

FormatDescription
Markdown (.md)Most commonly used format
Text (.txt)Plain text
JSON (.json)Structured data
YAML (.yaml)Configuration files

Document Structure

Recommended organization:

docs/
├── README.md              # Document library index
├── coding-standards.md    # Code standards
├── api-spec.md           # API specifications
├── naming-conventions.md  # Naming conventions
└── best-practices.md      # Best practices

MCP Resource Mapping

Ingested documents automatically map to MCP resources for AI queries:

resource://agile-builder/docs/coding-standards
resource://agile-builder/docs/api-spec
resource://agile-builder/docs/naming-conventions

Using with AI

After configuring MCP, AI can query like this:

"Show me our code standards"
"Generate CRUD code according to the API spec"
"Check if this naming follows our conventions"

Document Tags

Add tags to documents for easier management and retrieval:

tags:
  - code-standards
  - frontend
  - TypeScript

Recommended Common Tags

TagPurpose
code-standardsCode style, lint rules
api-specAPI design, data formats
naming-conventionsNaming rules for variables, functions, files
best-practicesExperience summaries, optimal approaches
architectureSystem design, module organization

Document Versioning

Documents support version control:

  1. Version history: Every edit is recorded
  2. Version rollback: Roll back to any previous version
  3. Version diff: Compare differences between versions

Team Sharing

Document Visibility

VisibilityDescription
PrivateOnly visible to you
TeamVisible to team members
PublicVisible to all users

Document Review

Teams can set up document review workflows:

  1. Submit document changes
  2. Team members review
  3. Merge into the official version

Combining with Templates

Using the document system together with the template system yields the best results:

Template defines structure ──────→ Generate project skeleton
    ↓
Documents define standards ──────→ AI queries for execution
    ↓
Generate projects that conform to standards

Next Steps