feat: add options for returning record data and raw responses/requests in execute_stream_test_read

[aaronsteers]

Simplify execute_stream_test_read to minimal implementation

Summary

This PR dramatically simplifies the execute_stream_test_read function from 172 lines to ~60 lines (66% reduction) by removing complex conditional logic and helper functions. The function now always returns both record data and raw request/response metadata with secrets filtered, eliminating the need for include_records and include_raw_response_data parameters.

Key Changes:

• Removed parameters: include_records and include_raw_response_data
• Deleted helper functions: _without_records and _without_raw_requests_and_responses
• Simplified logic: Always extract and return both records and slices data
• Updated tests: Removed mocked unit tests, kept integration tests
• Maintained security: Still applies filter_config_secrets to slices

Review & Testing Checklist for Human

⚠️ High Priority Items (5 items):

• Verify backward compatibility: Check if any existing code calls execute_stream_test_read with the removed parameters (include_records, include_raw_response_data)
• Test edge cases: Try various manifest types, error scenarios, and malformed inputs beyond the Rick and Morty example
• Verify security: Confirm that filter_config_secrets properly sanitizes all sensitive data in the slices output
• Performance testing: Check if always extracting both records and slices impacts memory usage or response times for large datasets
• Real-world validation: Test with actual production connector manifests to ensure the simplified logic handles all real-world scenarios

Recommended Test Plan:

1. Run the function with various connector manifests (not just Rick and Morty)
2. Test error scenarios (invalid manifests, network failures, malformed responses)
3. Verify no secrets appear in the returned slices data
4. Check performance with large record sets (test with max_records=1000)

---

Diagram

%%{ init : { "theme" : "default" }}%%
graph TD
    Caller["Function Callers"]
    TestRead["execute_stream_test_read<br/>(connector_builder.py)"]:::major-edit
    HelperFuncs["_without_records<br/>_without_raw_requests_and_responses<br/>(DELETED)"]:::major-edit
    StreamResult["StreamTestResult<br/>(model)"]:::minor-edit
    CDK["Airbyte CDK<br/>(read_stream)"]:::context
    Tests["tests/__init__.py<br/>(mocked tests DELETED)"]:::major-edit
    IntegrationTests["tests/test_integration.py<br/>(updated assertions)"]:::minor-edit
    
    Caller -->|"calls (params removed)"| TestRead
    TestRead -->|"DELETED"| HelperFuncs
    TestRead -->|"always returns both<br/>records + slices"| StreamResult
    TestRead -->|"calls"| CDK
    TestRead -->|"applies filter_config_secrets"| StreamResult
    Tests -->|"validates"| TestRead
    IntegrationTests -->|"validates"| TestRead
    
    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:#87CEEB
    classDef context fill:#FFFFFF

Loading

Notes

• Breaking change: This removes function parameters, so any existing callers will need updates
• Simplified approach: The "all or nothing" approach eliminates complex conditional logic but changes the function contract
• CI passing: All 63 tests pass including pytest on Python 3.10/3.11, but this doesn't guarantee backward compatibility
• Requested by: AJ Steers (@aaronsteers)
• Devin session: https://app.devin.ai/sessions/e31e9b3aeee54c569beec1aafa4e25cd

The main risk is that this is a breaking change disguised as a simplification. While the code is cleaner and the integration test passes, we need to verify no existing code depends on the removed functionality.

[devin-ai-integration]

Original prompt from AJ Steers

@Devin our connector builder mcp server doesn't return record data as of now in the test read tool. Can you see if that can be added? Maybe we can add an option to that tool called "summary only". If that is turned on then we won't return data otherwise we will.

[devin-ai-integration]

🤖 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

[github-actions]

👋 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/1754099079-add-summary-only-option", "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/1754099079-add-summary-only-option#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.

[Copilot]

Pull Request Overview

This PR adds functionality to optionally return actual record data from the execute_stream_test_read MCP tool. Previously, the tool only returned summary metadata. With the new summary_only parameter, users can now choose to receive the actual record data when summary_only=False, while maintaining backward compatibility with the default behavior.

• Added optional records field to StreamTestResult model to hold actual record data
• Added summary_only parameter to execute_stream_test_read function with default True for backward compatibility
• Implemented record extraction logic with fallback handling for different data structures

Reviewed Changes

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

File	Description
connector_builder_mcp/_connector_builder.py	Added records field to StreamTestResult model and summary_only parameter with record extraction logic
tests/init.py	Added comprehensive test cases for the new functionality including fallback scenarios

[github-actions]

PyTest Results (Fast)

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

Results for commit 083a63c. ± Comparison against base commit 53ee5ff.

♻️ This comment has been updated with latest results.

[github-actions]

PyTest Results (Full)

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

Results for commit 083a63c. ± Comparison against base commit 53ee5ff.

♻️ This comment has been updated with latest results.

[github-actions]

👋 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/1754099079-add-summary-only-option", "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/1754099079-add-summary-only-option#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.