🗺️ Mappy - ArcGIS JavaScript SDK Documentation Assistant

Your AI-powered companion for ArcGIS JavaScript SDK development

Get instant answers, code examples, and context-aware help directly in VS Code. Powered by advanced RAG (Retrieval-Augmented Generation) technology with the complete ArcGIS JavaScript SDK 4.34 documentation.

✨ Features

Chat Interface

Ask questions in natural language
Get accurate answers from official ArcGIS docs
See source citations with relevance scores
Persistent chat history across sessions

Right-click any ArcGIS class name
Select "Ask Mappy About This"
Instant documentation lookup
Zero friction workflow

📝 Smart Code Examples

Code Examples

Get working code snippets
Copy with one click
Insert directly into your editor
Syntax-highlighted output

🔍 Source Citations

Source Citations

Each answer comes with sources cited
Includes relevance score out of 100%
Helps verify accuracy and trustworthiness

⚡ Performance Optimized

Response caching (5-minute TTL)
Fast API responses
Minimal resource usage
Works offline with cached results

🚀 Getting Started

Installation

Open VS Code
Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
Search for "Mappy"
Click "Install"

Or install via command line:

code --install-extension ajitsingh.mappy-js-sdk

Usage

Click the Mappy icon in the Activity Bar (left sidebar)
Type your question about ArcGIS JavaScript SDK
Press Enter or click Send
Get instant answers with code examples!

Example questions:

"How do I create a 3D map?"
"What properties does MapView have?"
"Show me how to add a popup to a FeatureLayer"
"How to use SceneView with custom basemap?"

Place your cursor on any ArcGIS class name (e.g., MapView, FeatureLayer)
Right-click → "Ask Mappy About This"
Chat opens with pre-filled question
Edit if needed and press Enter

Method 3: Command Palette

Ctrl+Shift+P / Cmd+Shift+P
Type "Mappy: Ask Question"
Enter your question

📸 Screenshots

Ask questions and get instant answers with code examples:

User: How do I create a 2D map with a popup?

Mappy: Here's how to create a 2D map with a popup:

[Code example with MapView, Popup, and FeatureLayer]

Sources:
📚 MapView | Esri Documentation (95% relevant)
📚 Popup | Esri Documentation (88% relevant)

Hover over any ArcGIS class and ask Mappy:

import MapView from "@arcgis/core/views/MapView";
                      ↑
              [Right-click here]
              → "Ask Mappy About This"

⚙️ Configuration

Access settings via: File → Preferences → Settings → Search "Mappy"

Available Settings

Setting	Default	Description
`mappy.apiUrl`	`https://mappy-arcgis-js-assistant-production.up.railway.app`	API endpoint (use default or your own instance)
`mappy.enableChat`	`true`	Enable/disable chat sidebar
`mappy.cacheTimeout`	`300`	Cache timeout in seconds (5 minutes)
`mappy.sdkVersion`	`4.34`	ArcGIS JavaScript SDK version

🎯 Use Cases

Learning the SDK

New to ArcGIS JavaScript SDK? Ask Mappy to explain concepts, show examples, and guide you through common tasks.

Quick Reference

Forgot a property name or method signature? Right-click and ask Mappy for instant reference.

Code Generation

Need a working example? Ask Mappy and get copy-paste ready code snippets.

Troubleshooting

Stuck on an error? Describe the issue and get contextual help from official docs.

🛠️ Commands

Access via Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

Mappy: Open Chat - Open the chat sidebar
Mappy: Ask Question - Quick question input
Mappy: Ask Mappy About This - Ask about symbol under cursor
Mappy: Test API Connection - Verify backend connectivity
Mappy: Clear Cache - Clear response cache
Mappy: Reset Chat Panel - Clear chat history

🔧 Requirements

VS Code 1.85.0 or higher
Internet connection (for API queries)
Supported languages: JavaScript, TypeScript, HTML

📊 What's Under the Hood?

Mappy uses:

RAG (Retrieval-Augmented Generation) for accurate, source-based answers
Vector database with 34,000+ documentation embeddings
Claude AI for natural language understanding
ArcGIS JavaScript SDK 4.34 complete documentation
FastAPI backend hosted on Railway
Response caching for speed and efficiency

🆘 Troubleshooting

Extension not responding?

Check internet connection
Run: Mappy: Test API Connection
Check Output panel: View → Output → Mappy Assistant

Getting error messages?

Verify API URL in settings
Clear cache: Mappy: Clear Cache
Reload VS Code window

Chat not showing?

Click Mappy icon in Activity Bar
Or run: Mappy: Open Chat

🤝 Contributing

Found a bug or have a feature request?

GitHub Issues: Report here
GitHub Repo: View source

📄 License

MIT License - see LICENSE file for details

🌟 About

Mappy is built by developers, for developers. Our mission is to make ArcGIS JavaScript SDK development faster and more enjoyable by bringing AI-powered documentation assistance directly into your workflow.

Try the web version: mappy-js-sdk.vercel.app

🔗 Links

Made with ❤️ for the ArcGIS developer community

Happy mapping! 🗺️✨

Mappy - ArcGIS JS SDK Docs

ajitsingh