mongodb-nl-query-ai-agent/docs/getting-started.html at main · cisco-open/mongodb-nl-query-ai-agent · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Getting Started - MongoDB NL Query AI Agent</title>
    <style>
        * {
            margin: 0;
            padding: 0;
            box-sizing: border-box;
        }

        body {
            font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
            line-height: 1.6;
            color: #333;
            background: #f5f7fa;
        }

        .nav {
            background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
            color: white;
            padding: 15px 30px;
            display: flex;
            justify-content: space-between;
            align-items: center;
        }

        .nav a {
            color: white;
            text-decoration: none;
            font-weight: 500;
        }

        .nav a:hover {
            text-decoration: underline;
        }

        .container {
            max-width: 900px;
            margin: 40px auto;
            background: white;
            padding: 20px;
            border-radius: 10px;
            box-shadow: 0 2px 10px rgba(0,0,0,0.1);
        }

        h1 {
            color: #667eea;
            margin-bottom: 5px;
            font-size: 2.5em;
        }

        h2 {
            color: #667eea;
            margin-top: 5px;
            margin-bottom: 5px;
            padding-bottom: 10px;
            border-bottom: 2px solid #e0e0e0;
        }

        h3 {
            color: #555;
            margin-top: 5px;
            margin-bottom: 5px;
        }

        p {
            margin-bottom: 5px;
        }

        .info-box {
            background: #e8f4f8;
            border-left: 4px solid #667eea;
            padding: 15px;
            margin: 5px 0;
            border-radius: 5px;
        }

        .feature-grid {
            display: grid;
            grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
            gap: 20px;
            margin: 5px 0;
        }

        .feature {
            background: #f8f9fa;
            padding: 20px;
            border-radius: 8px;
            text-align: center;
        }

        .feature-icon {
            font-size: 2.5em;
            margin-bottom: 5px;
        }

        ul {
            margin-left: 20px;
            margin-bottom: 5px;
        }

        li {
            margin-bottom: 8px;
        }

        code {
            background: #f4f4f4;
            padding: 2px 6px;
            border-radius: 3px;
            font-family: 'Courier New', monospace;
        }

        .next-steps {
            background: #f8f9fa;
            padding: 20px;
            border-radius: 8px;
            margin-top: 5px;
        }

        .next-steps a {
            color: #667eea;
            text-decoration: none;
            font-weight: 500;
        }

        .next-steps a:hover {
            text-decoration: underline;
        }
    </style>
</head>
<body>
    <div class="nav">
        <div><a href="index.html">← Back to Documentation Hub</a></div>
        <div>MongoDB NL Query AI Agent - Getting Started</div>
    </div>

    <div class="container">
        <h1>🎯 Getting Started</h1>

        <h2>What is MongoDB NL Query AI Agent?</h2>
        <p>MongoDB NL Query AI Agent is an intelligent natural language interface that allows you to query MongoDB databases using plain English. Powered by LangGraph and advanced language models, it converts your questions into optimized MongoDB queries and returns results in a readable format.</p>

        <div class="info-box">
            <strong>💡 Key Insight:</strong> No need to write complex MongoDB aggregation pipelines or learn query syntax. Just ask your question naturally!
        </div>

        <h2>Key Features</h2>
        <div class="feature-grid">
            <div class="feature">
                <div class="feature-icon">🧠</div>
                <h3>AI-Powered</h3>
                <p>Uses GPT-4, Claude, or Azure OpenAI to understand your questions</p>
            </div>
            <div class="feature">
                <div class="feature-icon">🔌</div>
                <h3>Dual Modes</h3>
                <p>MCP Protocol or Direct PyMongo connection</p>
            </div>
            <div class="feature">
                <div class="feature-icon">⚡</div>
                <h3>Fast Setup</h3>
                <p>Get started in 5 minutes with direct connection</p>
            </div>
            <div class="feature">
                <div class="feature-icon">🎯</div>
                <h3>Smart Queries</h3>
                <p>Generates optimized MongoDB aggregation pipelines</p>
            </div>
        </div>

        <h2>How It Works</h2>
        <ol>
            <li><strong>You ask a question:</strong> "How many orders were completed last month?"</li>
            <li><strong>AI generates query:</strong> Converts to MongoDB aggregation pipeline</li>
            <li><strong>Query executes:</strong> Runs against your MongoDB database</li>
            <li><strong>Results formatted:</strong> Returns readable JSON response</li>
        </ol>

        <h2>Use Cases</h2>
        <ul>
            <li><strong>Business Analytics:</strong> Query sales data, customer metrics, and KPIs</li>
            <li><strong>Data Exploration:</strong> Discover patterns without writing queries</li>
            <li><strong>Report Generation:</strong> Extract data for dashboards and reports</li>
            <li><strong>Operational Queries:</strong> Check system status and monitoring data</li>
            <li><strong>Ad-hoc Analysis:</strong> Quick insights from your MongoDB collections</li>
        </ul>

        <h2>Connection Types</h2>

        <h3>🌐 MCP Protocol (Model Context Protocol)</h3>
        <p><strong>Best for:</strong> Integration with Claude Desktop, structured workflows</p>
        <ul>
            <li>Standardized protocol for AI-database communication</li>
            <li>OAuth authentication support</li>
            <li>Requires external MCP server</li>
            <li>Higher latency (~150ms via HTTP)</li>
        </ul>

        <h3>🔌 Direct Connection (PyMongo)</h3>
        <p><strong>Best for:</strong> Standalone applications, low latency requirements</p>
        <ul>
            <li>Direct MongoDB connection via PyMongo driver</li>
            <li>Minimal setup - just connection string</li>
            <li>Low latency (~10ms direct)</li>
            <li>No external dependencies</li>
        </ul>

        <div class="info-box">
            <strong>🚀 Recommendation:</strong> Start with Direct Connection for fastest setup. Migrate to MCP Protocol if you need Claude Desktop integration or enterprise OAuth.
        </div>

        <h2>Prerequisites</h2>
        <ul>
            <li><strong>Python:</strong> 3.10 or higher</li>
            <li><strong>MongoDB:</strong> Access to a MongoDB instance (v4.0+)</li>
            <li><strong>LLM Provider:</strong> API key for OpenAI, Anthropic, or Azure OpenAI</li>
            <li><strong>Operating System:</strong> macOS, Linux, or Windows</li>
        </ul>

        <div class="next-steps">
            <h3>📚 Next Steps</h3>
            <p>Choose your path:</p>
            <ul>
                <li><a href="comparison.html">⚖️ Compare MCP vs Direct</a> - Understand the differences</li>
                <li><a href="installation.html">📦 Install MongoDB NL Query AI Agent</a> - Get up and running</li>
                <li><a href="configuration.html">⚙️ Configure Connection</a> - Set up your environment</li>
            </ul>
        </div>
    </div>
</body>
</html>