Skip to content

Conversation

aaronsteers
Copy link
Contributor

docs: add VS Code MCP configuration and testing instructions

Summary

Added minimal documentation for VS Code MCP extension integration to help users test the MCP server directly within VS Code from their local checkout. The changes include:

  • New "VS Code MCP Extension" section in README.md that references the existing .vscode/mcp.json configuration file
  • New "VS Code MCP Testing" section in TESTING.md with concise instructions for VS Code users
  • Documentation kept minimal and maintainable per feedback

The documentation leverages the recently added .vscode/mcp.json file and provides users with an alternative to Claude Desktop for testing connector builder tools.

Review & Testing Checklist for Human

  • Verify VS Code MCP integration works end-to-end - Test that the .vscode/mcp.json configuration actually works with VS Code MCP extension and provides access to connector builder tools
  • Check documentation clarity - Ensure the minimal instructions are sufficient for users to successfully set up and use VS Code MCP integration
  • Validate technical accuracy - Confirm that the documented workflow matches how the VS Code MCP extension actually functions

Recommended test plan: Install VS Code MCP extension, open the repo in VS Code, verify that the MCP tools appear in the command palette, and test at least one connector builder operation (like validate_manifest) to ensure the integration works correctly.


Diagram

%%{ init : { "theme" : "default" }}%%
graph TD
    README["README.md<br/>MCP Client Configuration"]:::major-edit
    TESTING["TESTING.md<br/>Testing Guide"]:::major-edit
    VSCODE_CONFIG[".vscode/mcp.json<br/>VS Code MCP Config"]:::context
    
    README -->|references| VSCODE_CONFIG
    TESTING -->|references| VSCODE_CONFIG
    
    subgraph Legend
        L1["Major Edit"]:::major-edit
        L2["Minor Edit"]:::minor-edit  
        L3["Context/No Edit"]:::context
    end
    
    classDef major-edit fill:#90EE90
    classDef minor-edit fill:#ADD8E6
    classDef context fill:#FFFFFF
Loading

Notes

  • Documentation was intentionally kept concise to minimize future maintenance burden
  • The .vscode/mcp.json file was already present in the repository - this PR only adds documentation referencing it
  • Changes align with the repository's existing documentation patterns and structure

Link to Devin run: https://app.devin.ai/sessions/6e5eb01dce2d4a6a82c0b922ead2faad
Requested by: @aaronsteers

- Add VS Code MCP Extension section to README.md referencing .vscode/mcp.json
- Add minimal VS Code MCP Testing section to TESTING.md
- Keep documentation concise and maintainable per feedback

Co-Authored-By: AJ Steers <[email protected]>
@Copilot Copilot AI review requested due to automatic review settings August 6, 2025 19:11
Copy link
Contributor

Original prompt from AJ Steers
@Devin - I just added a Vs code MCP.json file to the connector builder MCP repo. Update our docs in readme.md and testing.md to reflect this and help users test the MCP server directly within vs code from their local checkout

Copy link
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds minimal documentation for VS Code MCP extension integration to provide users with an alternative testing method to Claude Desktop. The changes reference the existing .vscode/mcp.json configuration file and provide concise setup instructions.

  • Added VS Code MCP Extension section to README.md referencing the existing configuration file
  • Added VS Code MCP Testing section to TESTING.md with brief setup instructions
  • Documentation kept minimal for maintainability

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Added VS Code MCP Extension section referencing .vscode/mcp.json configuration
TESTING.md Added VS Code MCP Testing section with concise setup instructions for VS Code users

Copy link

github-actions bot commented Aug 6, 2025

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

Testing This Branch via MCP

To test the changes in this specific branch with an MCP client like Claude Desktop, use the following configuration:

{
  "mcpServers": {
    "connector-builder-mcp-dev": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/airbytehq/connector-builder-mcp.git@devin/1733511825-add-vscode-mcp-docs", "connector-builder-mcp"]
    }
  }
}

Testing This Branch via CLI

You can test this version of the MCP Server using the following CLI snippet:

# Run the CLI from this branch:
uvx 'git+https://github.com/airbytehq/connector-builder-mcp.git@devin/1733511825-add-vscode-mcp-docs#egg=airbyte-connector-builder-mcp' --help

PR Slash Commands

Airbyte Maintainers can execute the following slash commands on your PR:

  • /autofix - Fixes most formatting and linting issues
  • /poe <command> - Runs any poe command in the uv virtual environment

📝 Edit this welcome message.

Copy link

github-actions bot commented Aug 6, 2025

PyTest Results (Fast)

0 tests  ±0   0 ✅ ±0   0s ⏱️ ±0s
0 suites ±0   0 💤 ±0 
0 files   ±0   0 ❌ ±0 

Results for commit d830586. ± Comparison against base commit 53ee5ff.

@aaronsteers aaronsteers merged commit 0862d03 into main Aug 6, 2025
12 checks passed
@aaronsteers aaronsteers deleted the devin/1733511825-add-vscode-mcp-docs branch August 6, 2025 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant