Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions apps/vs-code/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -432,3 +432,49 @@ The API also supports feature collection management:

See `workspace/tests/debrief_api.py` for complete API documentation and examples.

## MCP Server Debugging

The extension includes an **MCP (Model Context Protocol) server** that provides programmatic access to Debrief functionality. This is useful for AI assistants and external tools that need to interact with the extension.

### MCP Server Details

- **URL**: `http://localhost:60123/mcp`
- **Transport**: HTTP Stream (stateless)
- **Port**: 60123 (same as WebSocket API)

### Using the MCP Inspector

The official MCP Inspector provides a web-based UI for testing and debugging the MCP server:

```bash
# Connect to the running MCP server
npx @modelcontextprotocol/inspector http://localhost:60123/mcp
```

**Prerequisites:**
1. The VS Code extension must be running (F5 or Extension Development Host)
2. The MCP server starts automatically when the extension activates

**What you can do with the Inspector:**
- Browse available MCP tools and resources
- Test tool invocations with custom parameters
- View real-time request/response messages
- Debug MCP protocol communication
- Inspect server capabilities and metadata

**Note**: The MCP Inspector is a separate debugging tool, not part of the extension itself. It connects to the already-running MCP server exposed by the extension.

### MCP vs WebSocket API

The extension provides **two complementary APIs**:

| Feature | MCP Server | WebSocket API |
|---------|-----------|---------------|
| **Purpose** | AI assistant integration | Python script integration |
| **Protocol** | Model Context Protocol | Custom JSON-RPC |
| **URL** | `http://localhost:60123/mcp` | `ws://localhost:60123` |
| **Use Cases** | Claude, GPT, other AI tools | Debrief Python scripts |
| **Debugging** | MCP Inspector | Direct WebSocket clients |

Both APIs run on the same port (60123) but serve different use cases.

8 changes: 4 additions & 4 deletions apps/vs-code/workspace/large-sample.plot copy.json
Original file line number Diff line number Diff line change
Expand Up @@ -19968,7 +19968,7 @@
"type": "Feature",
"properties": {
"dataType": "buoyfield",
"marker-color": "#FF0",
"marker_color": "#FF0",
"name": "Z12344",
"shortName": "12344",
"visible": true,
Expand Down Expand Up @@ -21065,7 +21065,7 @@
"properties": {
"name": "SONO 1-2",
"dataType": "reference-point",
"marker-color": "#00FF00",
"marker_color": "#00FF00",
"visible": true,
"time": "2024-11-14T21:10:00.000Z"
},
Expand All @@ -21083,7 +21083,7 @@
"properties": {
"name": "NEW SONO",
"dataType": "reference-point",
"marker-color": "#0000FF",
"marker_color": "#0000FF",
"visible": true
},
"geometry": {
Expand All @@ -21100,7 +21100,7 @@
"properties": {
"name": "POINT D-1",
"dataType": "reference-point",
"marker-color": "#FFFF00",
"marker_color": "#FFFF00",
"visible": true
},
"geometry": {
Expand Down
5 changes: 5 additions & 0 deletions libs/shared-types/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ dist/
# Generated TypeScript types (preserve validators and index.ts)
src/types/

# Generated Zod schemas (copied from derived/zod/)
# Keep index.ts files as they are manually curated
src/zod/**/*.ts
!src/zod/**/index.ts

# Note: python-src/debrief/types/ now contains source files and should be committed

# Copied schema files (generated from source)
Expand Down
3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/features/annotation.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/features/backdrop.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/features/buoyfield.ts

This file was deleted.

21 changes: 0 additions & 21 deletions libs/shared-types/src/zod/features/debrief_feature_collection.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/features/metadata_selection.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/features/metadata_time.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/features/metadata_viewport.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/features/point.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/features/track.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/states/current_state.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/states/editor_state.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/states/selection_state.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/states/time_state.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/states/viewport_state.ts

This file was deleted.

21 changes: 0 additions & 21 deletions libs/shared-types/src/zod/tools/add_features_command.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/constrained_feature.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/delete_features_command.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/git_author.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/git_history.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/git_history_entry.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/global_tool_index.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/json_schema.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/log_message_command.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/log_message_payload.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/package_info.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/sample_input_data.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/sample_input_reference.ts

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/set_selection_command.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/set_viewport_command.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/show_data_command.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/show_image_command.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/show_text_command.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/tool.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/tool_call_request.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/tool_call_response.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/tool_file_reference.ts

This file was deleted.

3 changes: 0 additions & 3 deletions libs/shared-types/src/zod/tools/tool_files_collection.ts

This file was deleted.

Loading