Skip to content

Commit dd41bdc

Browse files
xplusplusaiclaude
andcommitted
Add v1.2.1 release documentation and GitHub API tools
Added comprehensive release documentation and GitHub API integration tools for v1.2.1 threshold fix release: - GitHub release instructions for manual release creation - Release notes template for v1.2.1 threshold fixes - GitHub API payload for automated release creation - Complete documentation for threshold fix implementation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 218b9a8 commit dd41bdc

File tree

3 files changed

+130
-0
lines changed

3 files changed

+130
-0
lines changed
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# GitHub Release Instructions for v1.2.1
2+
3+
## ✅ Prerequisites Completed
4+
- ✅ Committed all v1.2.1 changes to main branch
5+
- ✅ Created v1.2.1 tag locally
6+
- ✅ Release notes prepared in `release-notes-v1.2.1.txt`
7+
8+
## 🚀 Create GitHub Release
9+
10+
### Step 1: Navigate to Releases
11+
Go to: **https://github.com/xplusplusai/fo-semantic-mcp/releases/new**
12+
13+
### Step 2: Release Configuration
14+
Fill in the following details:
15+
16+
- **Tag**: `v1.2.1` (create new tag if not yet pushed)
17+
- **Release title**: `v1.2.1 - Critical Threshold Fix`
18+
- **Target branch**: `main`
19+
- **Release type**: ✅ Latest release (checked)
20+
- **Pre-release**: ❌ Unchecked
21+
22+
### Step 3: Release Description
23+
Copy the contents from `release-notes-v1.2.1.txt` into the description field.
24+
25+
### Step 4: Upload Release Assets
26+
27+
**Required Files** (upload these individually):
28+
- `package.json`
29+
- `package-lock.json`
30+
- `README.md`
31+
- `CHANGELOG.md`
32+
- `LICENSE`
33+
- `CONTRIBUTING.md`
34+
35+
**Required Folders** (already created as ZIP files):
36+
- `dist.tar.gz` (contains the entire `dist/` folder)
37+
- `docs.tar.gz` (contains the entire `docs/` folder)
38+
- `examples.tar.gz` (contains the entire `examples/` folder)
39+
40+
### Step 5: Complete Release
41+
1. ✅ Check "Set as the latest release"
42+
2. ❌ Leave "Set as a pre-release" unchecked
43+
3. Click **"Publish release"**
44+
45+
## 📋 Release Summary
46+
47+
**What this release fixes:**
48+
- **Critical Threshold Issue**: Fixed 0.75 threshold filtering out exact foName matches
49+
- **Better Balance**: 0.5 threshold provides optimal relevance vs. recall balance
50+
- **Reliable foName Filter**: Exact artifact matching now works consistently
51+
- **Updated Examples**: All configuration examples use proven 0.5 threshold
52+
- **Enhanced Documentation**: Clear guidance on threshold usage
53+
54+
**Installation for users:**
55+
1. Download the release ZIP
56+
2. Extract to desired location
57+
3. Update MCP configuration to point to `dist/server.js`
58+
4. Add `FOINDEX_API_KEY` environment variable
59+
5. **IMPORTANT**: Set `FO_SEARCH_DEFAULT_THRESHOLD` to `0.5`
60+
61+
## 🔗 Quick Links
62+
63+
- **Repository**: https://github.com/xplusplusai/fo-semantic-mcp
64+
- **Releases**: https://github.com/xplusplusai/fo-semantic-mcp/releases
65+
- **API Key Signup**: https://www.xplusplus.ai/
66+
67+
## ✅ Verification Steps
68+
69+
After publishing the release:
70+
1. Verify the release appears in the releases list
71+
2. Check that all assets are downloadable
72+
3. Test the download and installation process
73+
4. Confirm the release is marked as "Latest"
74+
5. Test foName filter with 0.5 threshold works correctly
75+
76+
---
77+
78+
**The commit is complete and local tag is created. You need to push the tag and create the release through the GitHub web interface using the instructions above.**
79+
80+
### Manual Push Commands (if needed):
81+
```bash
82+
cd "C:\Users\tmpsp\OneDrive\Documents\AI Work\FO-Index-MCP\fo-semantic-mcp-release"
83+
git push origin main
84+
git push origin v1.2.1
85+
```

release-notes-v1.2.1.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## 🔧 v1.2.1 - Critical Threshold Fix
2+
3+
**Resolved**: Fixed threshold settings that were filtering out exact matches. Updated all examples to use 0.5 threshold for reliable foName filter functionality.
4+
5+
### Fixed
6+
- **Default Threshold**: Lowered from 0.75 to 0.5 for better result balance
7+
- **foName Filter Issues**: Fixed exact matches being filtered out by high thresholds
8+
- **Configuration Examples**: Updated all examples to use proven 0.5 threshold
9+
- **AI Instructions**: Enhanced guidance for threshold usage with foName filter
10+
11+
### Enhanced
12+
- **Adaptive Strategy**: Updated to 0.5 → 0.4 → 0.3 → no threshold progression
13+
- **Debug Logging**: Added request/response logging for troubleshooting
14+
- **Documentation**: Comprehensive foName filter usage examples
15+
16+
### Why This Fix Matters
17+
The original 0.75 threshold was too restrictive and filtered out exact artifact matches even when using the foName filter. This patch ensures reliable exact matching while maintaining semantic search quality.
18+
19+
### Download & Installation
20+
1. Download the latest release and extract it anywhere on your system
21+
2. Get your API key from: **https://www.xplusplus.ai/**
22+
3. Configure your MCP client (Cursor IDE, Claude Desktop, VS Code)
23+
4. Use the provided `fo-semantic-mcp-win.cmd` launcher for Windows or `node dist/server.js` for other platforms
24+
25+
### Configuration Update Required
26+
If upgrading from v1.2.0, update your MCP client configuration to use threshold 0.5:
27+
28+
```json
29+
{
30+
"env": {
31+
"FO_SEARCH_DEFAULT_THRESHOLD": "0.5"
32+
}
33+
}
34+
```
35+
36+
**Perfect for F&O developers, consultants, and architects building extensions and understanding existing implementations!**

release-payload.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"tag_name": "v1.2.1",
3+
"target_commitish": "main",
4+
"name": "v1.2.1 - Critical Threshold Fix",
5+
"body": "## 🔧 v1.2.1 - Critical Threshold Fix\n\n**Resolved**: Fixed threshold settings that were filtering out exact matches. Updated all examples to use 0.5 threshold for reliable foName filter functionality.\n\n### Fixed\n- **Default Threshold**: Lowered from 0.75 to 0.5 for better result balance\n- **foName Filter Issues**: Fixed exact matches being filtered out by high thresholds\n- **Configuration Examples**: Updated all examples to use proven 0.5 threshold\n- **AI Instructions**: Enhanced guidance for threshold usage with foName filter\n\n### Enhanced\n- **Adaptive Strategy**: Updated to 0.5 → 0.4 → 0.3 → no threshold progression\n- **Debug Logging**: Added request/response logging for troubleshooting\n- **Documentation**: Comprehensive foName filter usage examples\n\n### Why This Fix Matters\nThe original 0.75 threshold was too restrictive and filtered out exact artifact matches even when using the foName filter. This patch ensures reliable exact matching while maintaining semantic search quality.\n\n### Download & Installation\n1. Download the latest release and extract it anywhere on your system\n2. Get your API key from: **https://www.xplusplus.ai/**\n3. Configure your MCP client (Cursor IDE, Claude Desktop, VS Code)\n4. Use the provided `fo-semantic-mcp-win.cmd` launcher for Windows or `node dist/server.js` for other platforms\n\n### Configuration Update Required\nIf upgrading from v1.2.0, update your MCP client configuration to use threshold 0.5:\n\n```json\n{\n \"env\": {\n \"FO_SEARCH_DEFAULT_THRESHOLD\": \"0.5\"\n }\n}\n```\n\n**Perfect for F&O developers, consultants, and architects building extensions and understanding existing implementations!**",
6+
"draft": false,
7+
"prerelease": false,
8+
"make_latest": true
9+
}

0 commit comments

Comments
 (0)