Skip to content

Commit 3c46b67

Browse files
xplusplusaiclaude
andcommitted
Update GETTING_STARTED.md for v2.0.0 Node.js distribution
- Changed from binary executables to Node.js source package - Added npm install step - Updated configuration examples - Added MCP prompt usage section (Claude Desktop) - Updated troubleshooting guide - Added v2.0 features section 🤖 Generated with Claude Code (https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 47125db commit 3c46b67

File tree

1 file changed

+166
-22
lines changed

1 file changed

+166
-22
lines changed

docs/GETTING_STARTED.md

Lines changed: 166 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,40 @@
22

33
## 🚀 Quick Setup (5 minutes)
44

5-
### 1. Download & Place Binary
6-
- Download your platform's binary from the [latest release](https://github.com/xplusplusai/fo-semantic-mcp/releases)
7-
- Place it anywhere (e.g., `C:\Downloads\fo-semantic-mcp-win.exe`)
8-
- Make executable on macOS/Linux: `chmod +x fo-semantic-mcp-*`
5+
### Prerequisites
6+
7+
- **Node.js 18+** - Download from https://nodejs.org/
8+
- **API Key** - Get yours at https://www.xplusplus.ai/
9+
10+
### 1. Download & Extract
11+
12+
1. Download the latest release from [GitHub Releases](https://github.com/xplusplusai/fo-semantic-mcp/releases)
13+
2. Extract the zip/tar.gz to any location (e.g., `C:\tools\fo-semantic-mcp`)
14+
15+
### 2. Install Dependencies
16+
17+
```bash
18+
cd fo-semantic-mcp
19+
npm install
20+
```
21+
22+
This installs the required packages (@modelcontextprotocol/sdk, node-fetch, zod).
23+
24+
### 3. Get API Key
925

10-
### 2. Get API Key
1126
- Visit: https://www.xplusplus.ai/
1227
- Sign up for a plan
13-
- Copy your API key
28+
- Copy your API key (starts with `ak_`)
1429

15-
### 3. Configure Your IDE
30+
### 4. Configure Your AI Client
1631

17-
**Cursor IDE** (`~/.cursor/mcp.json`):
32+
**Cursor IDE** (`~/.cursor/mcp.json` or `%USERPROFILE%\.cursor\mcp.json`):
1833
```json
1934
{
2035
"mcpServers": {
2136
"fo-semantic-mcp": {
22-
"command": "C:\\Downloads\\fo-semantic-mcp-win.exe",
37+
"command": "node",
38+
"args": ["C:\\tools\\fo-semantic-mcp\\dist\\server.js"],
2339
"env": {
2440
"FOINDEX_API_KEY": "your_api_key_here"
2541
}
@@ -28,12 +44,13 @@
2844
}
2945
```
3046

31-
**Claude Desktop** (`~/AppData/Roaming/Claude/claude_desktop_config.json`):
47+
**Claude Desktop** (Windows: `~/AppData/Roaming/Claude/claude_desktop_config.json`):
3248
```json
3349
{
3450
"mcpServers": {
3551
"fo-semantic-mcp": {
36-
"command": "C:\\Downloads\\fo-semantic-mcp-win.exe",
52+
"command": "node",
53+
"args": ["/path/to/fo-semantic-mcp/dist/server.js"],
3754
"env": {
3855
"FOINDEX_API_KEY": "your_api_key_here"
3956
}
@@ -42,32 +59,159 @@
4259
}
4360
```
4461

45-
### 4. Restart & Test
46-
1. Restart your IDE
47-
2. Look for green MCP indicator
48-
3. Try: "Find customer payment processing examples"
62+
**macOS/Linux** paths use forward slashes:
63+
```json
64+
{
65+
"args": ["/Users/yourname/fo-semantic-mcp/dist/server.js"]
66+
}
67+
```
68+
69+
### 5. Restart & Test
70+
71+
1. **Completely restart** your AI client (Cursor IDE or Claude Desktop)
72+
2. Look for the MCP connection in logs/status
73+
3. Try a search: **"Find customer payment processing examples in D365 F&O"**
74+
75+
## 🔧 Optional: Local F&O File Access
4976

50-
## 🔧 Optional: Local F&O Integration
77+
To enable reading your local F&O XML files, add `FO_LOCAL_ASSETS_PATH`:
78+
79+
### Finding Your PackagesLocalDirectory
80+
81+
**Windows:**
82+
```powershell
83+
Get-ChildItem "$env:LOCALAPPDATA\Microsoft\Dynamics365\" -Recurse -Filter "PackagesLocalDirectory" | Select-Object FullName
84+
```
85+
86+
Example path: `C:\Users\YourName\AppData\Local\Microsoft\Dynamics365\10.0.2263.74\PackagesLocalDirectory`
87+
88+
### Add to Configuration
5189

52-
To enable reading your local F&O XML files, add:
5390
```json
54-
"FO_LOCAL_ASSETS_PATH": "C:\\Users\\[firstname.lastname]\\AppData\\Local\\Microsoft\\Dynamics365\\10.0.2263.74\\PackagesLocalDirectory"
91+
{
92+
"mcpServers": {
93+
"fo-semantic-mcp": {
94+
"command": "node",
95+
"args": ["C:\\tools\\fo-semantic-mcp\\dist\\server.js"],
96+
"env": {
97+
"FOINDEX_API_KEY": "your_api_key_here",
98+
"FO_LOCAL_ASSETS_PATH": "C:\\Users\\YourName\\AppData\\Local\\Microsoft\\Dynamics365\\10.0.2263.74\\PackagesLocalDirectory"
99+
}
100+
}
101+
}
102+
}
55103
```
56104

57-
Replace `[firstname.lastname]` with your actual Windows username.
105+
## 🎯 Using the MCP Prompt (Claude Desktop Only)
106+
107+
Claude Desktop supports MCP prompts for guided workflows.
108+
109+
### Invoke the Development Assistant
110+
111+
1. In Claude Desktop, type `/` to see available prompts
112+
2. Select `fo-development-assistant`
113+
3. Enter your F&O development task (e.g., "Add field to SalesTable header")
114+
4. Claude will follow the 6-step workflow automatically
115+
116+
### The 6-Step Workflow
117+
118+
When you invoke the prompt, Claude will:
119+
1. Search standard D365 artifacts
120+
2. Read standard implementations
121+
3. Search your workspace for custom code
122+
4. Read your customizations
123+
5. Generate context-aware solutions
124+
6. Present comprehensive analysis
125+
126+
**Note:** This workflow is user-invoked via the prompt selector. In Cursor IDE (which doesn't support prompts), you can guide the AI through similar steps manually.
58127

59128
## ✅ You're Ready!
60129

61130
Your AI assistant now has access to 50,000+ F&O artifacts and can help with:
62131
- Finding implementation examples
63-
- Understanding F&O patterns
132+
- Understanding F&O patterns and best practices
64133
- Accelerating extension development
65134
- Learning existing code
135+
- Context-aware code generation
136+
137+
## 💡 Example Queries
138+
139+
### Basic Searches
140+
```
141+
"Find customer tables in D365"
142+
"Show me sales order forms"
143+
"Search for pricing calculation classes"
144+
"Find inventory transaction data entities"
145+
```
146+
147+
### With Context
148+
```
149+
"What forms should I extend for a SalesTable header field?"
150+
"How does Microsoft implement purchase order validation?"
151+
"Find examples of data entity extensions"
152+
```
153+
154+
### In Claude Desktop (with prompt)
155+
```
156+
Invoke: fo-development-assistant
157+
Task: "Add custom approval workflow to purchase orders"
158+
```
159+
160+
## 🔧 Configuration Options
161+
162+
Add these to the `env` section as needed:
163+
164+
| Variable | Description | Default | Example |
165+
|----------|-------------|---------|---------|
166+
| `FOINDEX_API_KEY` | **Required** - Your API key | - | `ak_xxx...` |
167+
| `FO_LOCAL_ASSETS_PATH` | Path to PackagesLocalDirectory | - | `C:\Users\...\PackagesLocalDirectory` |
168+
| `FO_SEARCH_DEFAULT_THRESHOLD` | Relevance filter (0-1) | `0.5` | `0.4` |
169+
| `FO_SEARCH_TIMEOUT_MS` | Request timeout | `10000` | `30000` |
170+
| `FO_SEARCH_DEFAULT_LIMIT` | Default result count | `10` | `20` |
171+
| `FO_SEARCH_MAX_LIMIT` | Maximum results | `50` | `100` |
172+
173+
## 🐛 Troubleshooting
174+
175+
### "FOINDEX_API_KEY environment variable is required"
176+
- Verify API key is set in `env` section
177+
- Check for typos in the key
178+
- Ensure key starts with `ak_`
179+
180+
### "Cannot connect to search API"
181+
- Check internet connection
182+
- Verify API key is active at https://www.xplusplus.ai/
183+
184+
### Server not starting
185+
```bash
186+
# Test manually
187+
cd fo-semantic-mcp
188+
node dist/server.js
189+
# Should show: "FOINDEX_API_KEY environment variable is required"
190+
# (This is expected - means server is working)
191+
```
192+
193+
### Local files not accessible
194+
- Verify `FO_LOCAL_ASSETS_PATH` points to correct directory
195+
- Use double backslashes in Windows paths: `C:\\Users\\...`
196+
- Check directory exists and is readable
66197

67198
## 🆘 Need Help?
68199

69-
- **Issues**: Report bugs on GitHub
200+
- **Issues**: Report bugs at [GitHub Issues](https://github.com/xplusplusai/fo-semantic-mcp/issues)
70201
- **Documentation**: See main [README](../README.md) for detailed features
202+
- **Changelog**: See [CHANGELOG](../CHANGELOG.md) for version history
71203
- **Support**: contact@xplusplus.ai
72204

73-
Happy F&O development! 🎯
205+
## 📖 What's New in v2.0
206+
207+
- ✅ Simplified architecture following proper MCP design
208+
- ✅ Clean tool responses (data only, no checklists)
209+
- ✅ Single clear prompt: `fo-development-assistant`
210+
- ✅ Honest documentation about capabilities
211+
- ✅ Production-ready package structure
212+
213+
See [CHANGELOG.md](../CHANGELOG.md) for full details.
214+
215+
---
216+
217+
Happy F&O development! 🎯

0 commit comments

Comments
 (0)