PolyHedra / docs /STARTUP_FLOWCHART.md
yf176
Deploy Polyhedra to HF Spaces
891fe52
|
Raw History Blame Contribute Delete
6.26 kB

Polyhedra Startup Flowchart

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                    Polyhedra MCP Server                      β”‚
β”‚                      Startup Flow                            β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

                            Start
                             β”‚
                             β–Ό
                β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
                β”‚  Dependencies installed?β”‚
                β”‚  pip install -e .      β”‚
                β””β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                        β”‚
                   Yes  β”‚   No
            β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
            β”‚                        β”‚
            β–Ό                        β–Ό
    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”         β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
    β”‚ Run diagnosticβ”‚         β”‚ Install deps     β”‚
    β”‚ test_quick    β”‚         β”‚ pip install -e . β”‚
    β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜         β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
           β”‚                          β”‚
           β”‚ Pass                     β”‚
           β”‚                          β”‚
           β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                      β”‚
                      β–Ό
            β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
            β”‚ Config updated?      β”‚
            β”‚ .vscode/settings.jsonβ”‚
            β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                      β”‚
                 Yes  β”‚   No
          β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
          β”‚                         β”‚
          β–Ό                         β–Ό
   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”         β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
   β”‚ Reload        β”‚         β”‚ See FIX_GUIDE.md  β”‚
   β”‚ VS Code       β”‚         β”‚ Update config     β”‚
   β”‚ Ctrl+Shift+P  β”‚         β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
   β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”˜
          β”‚
          β–Ό
   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
   β”‚ MCP server auto-startsβ”‚
   β”‚ (runs in background) β”‚
   β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
          β”‚
          β–Ό
   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
   β”‚ Check output panel   β”‚
   β”‚ Ctrl+Shift+U -> MCP  β”‚
   β””β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
          β”‚
          β–Ό
   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
   β”‚ See "Server ready"?      β”‚
   β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
        β”‚           β”‚
     Yesβ”‚           β”‚ No
        β”‚           β”‚
        β–Ό           β–Ό
   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
   β”‚ Success!β”‚  β”‚ Check errors  β”‚
   β””β”€β”€β”€β”¬β”€β”€β”€β”€β”˜  β”‚ See           β”‚
       β”‚       β”‚ FIX_GUIDE.md  β”‚
       β”‚       β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
       β–Ό
   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
   β”‚ Test in Copilot          β”‚
   β”‚ "Search transformer papers"β”‚
   β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
       β”‚
       β–Ό
   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
   β”‚ ✨ Start using Polyhedra!β”‚
   β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Quick Command Reference

Windows PowerShell

# πŸ“‹ Diagnostic and testing
.\test_quick.ps1              # Quick diagnostic
.\run_demo.ps1                # Run demo
python test_fix.py            # Detailed test

# πŸ”§ Development commands
.\.venv\Scripts\Activate.ps1  # Activate virtual environment
python -m pytest              # Run tests
python demo_search.py         # Run search demo

# πŸ› Debug
python -m polyhedra.server    # Manually start server (Ctrl+C to stop)

Batch Files

test_quick.bat    # Quick diagnostic
run_demo.bat      # Run demo

Three Usage Methods

1️⃣ Via IDE (Recommended)

VS Code starts
    ↓
Auto-start MCP server
    ↓
Use in Copilot chat
    ↓
Polyhedra tools auto-called

Advantages:

  • βœ… Auto-start
  • βœ… No manual management
  • βœ… Integrated in chat

2️⃣ Python Scripts

from polyhedra.services.semantic_scholar import SemanticScholarService
import asyncio

async def main():
    service = SemanticScholarService()
    papers = await service.search("AI", limit=5)
    print(papers)

asyncio.run(main())

Advantages:

  • βœ… Programmatic control
  • βœ… Batch processing
  • βœ… Custom workflows

3️⃣ Command Line Demo

.\run_demo.ps1

Advantages:

  • βœ… Quick testing
  • βœ… Learn features
  • βœ… No IDE needed

Status Indicators

βœ… Running Normally

MCP output: [polyhedra] Server ready
Copilot: Can call Polyhedra tools
Test: test_quick.ps1 all pass

⚠️ Needs Check

MCP output: No logs
Copilot: Can't see Polyhedra tools
Test: Some failures

Fix: Reload VS Code

❌ Has Problems

MCP output: Error messages
Copilot: Tool call failures
Test: Failed

Fix: See FIX_GUIDE.md


Next Steps

  1. βœ… Ensure diagnostic passes: .\test_quick.ps1
  2. πŸ”„ Reload VS Code
  3. πŸ“ Test in Copilot
  4. πŸ“š See docs/USER_GUIDE.md to learn more