File size: 5,247 Bytes
891fe52 | 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 235 236 237 238 239 240 241 242 243 244 245 | # Polyhedra Startup Guide
## π Quick Start (Recommended)
Polyhedra as an **MCP server** is automatically launched by your IDE. No manual startup needed!
### Step 1: Reload VS Code
**Must do this first!**
1. Press `Ctrl+Shift+P` (or `F1`)
2. Type and select: **"Developer: Reload Window"**
3. Or simply close and reopen VS Code
### Step 2: Verify MCP Server Started
Open VS Code's Output panel:
1. Press `Ctrl+Shift+U` to open Output panel
2. Select **"MCP"** from dropdown menu
3. Should see logs like:
```
[polyhedra] Starting MCP server...
[polyhedra] Server ready
```
### Step 3: Test Functionality
Test in **GitHub Copilot Chat**:
```
Search for papers about transformer architecture
```
Copilot should automatically call Polyhedra's MCP tools!
---
## π§ͺ Testing and Verification
### Quick Diagnostic Test
**Windows PowerShell:**
```powershell
.\test_quick.ps1
```
**Or use batch file:**
```cmd
test_quick.bat
```
This verifies:
- β
Python environment is correct
- β
All dependencies installed
- β
Services can be imported normally
### Run Demo (No IDE Needed)
**PowerShell:**
```powershell
.\run_demo.ps1
```
**Batch:**
```cmd
run_demo.bat
```
**Or directly with Python:**
```powershell
.\.venv\Scripts\python.exe demo_search.py
```
---
## π οΈ Manual Startup Methods
### Method 1: Via VS Code (Recommended)
MCP server automatically starts when VS Code launches. Configuration is in:
- `mcp.servers` section of `.vscode/settings.json`
### Method 2: Command Line Testing (Development/Debug)
**Only for testing if server can start, press Ctrl+C to stop:**
```powershell
# Activate virtual environment
.\.venv\Scripts\Activate.ps1
# Start MCP server
python -m polyhedra.server
```
**Note**: Server will wait for JSON-RPC input, this is normal. Press `Ctrl+C` to stop.
### Method 3: Using Python API (In Scripts)
```python
# demo_search.py is an example
import asyncio
from polyhedra.services.semantic_scholar import SemanticScholarService
async def main():
service = SemanticScholarService()
papers = await service.search("transformer", limit=5)
print(f"Found {len(papers)} papers")
asyncio.run(main())
```
---
## π Check if MCP Tools Are Available
### In VS Code Copilot
1. Open Copilot Chat (sidebar icon or `Ctrl+Alt+I`)
2. Type `@workspace` then press space
3. Should see command prompts like `/`
4. Or directly ask: "Search for papers"
### View Available Tools
Ask in Copilot chat:
```
What tools are available in Polyhedra?
```
Or check documentation:
```powershell
cat docs\API.md
```
---
## β Common Issues
### Q: How to know if MCP server is running?
**A:** Check VS Code Output panel (MCP channel):
- Has logs = Running β
- Errors = Configuration problem β
- No output = Not started or not configured β οΈ
### Q: Need to restart after code changes?
**A:** Yes. After modifying code:
1. Press `Ctrl+Shift+P`
2. Select "Developer: Reload Window"
### Q: MCP tools not available?
**A:** Check in order:
1. β
Run `.\test_quick.ps1` to ensure basic functionality works
2. β
Check MCP output panel for error messages
3. β
Confirm `.vscode/settings.json` configuration is correct
4. β
Reload VS Code
5. β
See `FIX_GUIDE.md` for detailed troubleshooting
### Q: Want to test specific functionality?
**A:** Use test scripts:
```powershell
# Run all tests
.\.venv\Scripts\python.exe -m pytest tests/
# Test specific functionality
.\.venv\Scripts\python.exe -m pytest tests/test_services/test_semantic_scholar.py
# Run demo
.\.venv\Scripts\python.exe demo_search.py
```
### Q: How to debug MCP server?
**A:**
1. Check MCP output panel logs
2. Add logging to code:
```python
import logging
logging.basicConfig(level=logging.DEBUG)
```
3. Manually run server to see full output:
```powershell
.\.venv\Scripts\python.exe -m polyhedra.server
```
---
## π Startup Checklist
After completing all steps, verify:
- [ ] Virtual environment created: `.venv` folder exists
- [ ] Dependencies installed: `pip list` shows polyhedra
- [ ] Configuration updated: `.vscode/settings.json` uses local Python
- [ ] VS Code reloaded
- [ ] MCP output panel shows server startup
- [ ] Diagnostic test passes: `.\test_quick.ps1`
- [ ] Copilot can call Polyhedra tools
---
## π― Recommended Workflow
### First Time Use
```powershell
# 1. Verify installation
.\test_quick.ps1
# 2. Run demo to understand features
.\run_demo.ps1
# 3. Reload VS Code
# Ctrl+Shift+P -> "Reload Window"
# 4. Test in Copilot
# "Search for transformer papers"
```
### Daily Development
```powershell
# After modifying code
# Ctrl+Shift+P -> "Reload Window"
# Run tests
.\.venv\Scripts\python.exe -m pytest
# Use Copilot to interact with Polyhedra
```
---
## π Related Documentation
- **API Documentation**: `docs/API.md` - Detailed description of all 10 tools
- **Fix Guide**: `FIX_GUIDE.md` - Troubleshooting
- **User Guide**: `docs/USER_GUIDE.md` - Usage examples
- **IDE Configuration**: `ide-integration/SETUP_GUIDE.md` - Detailed configuration instructions
---
**Tip**: Polyhedra is an MCP tool server that extends AI assistant capabilities. You don't need to "run" it directly, but use its features through AI chat in your IDE!
|