feat: add get_connector_builder_docs tool for LLM guidance #6
Conversation
- Add comprehensive connector building documentation function - Provide high-level process guidance and available tools overview - Support topic-specific documentation via raw GitHub URLs - Follow existing FastMCP tool registration patterns - Add requests dependency and types-requests for type checking Requested by @aaronsteers for builder-mcp repository Co-Authored-By: AJ Steers <[email protected]>
Original prompt from AJ Steers |
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
|
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. Testing This VersionYou can test this version of the MCP Server using the following: # Run the CLI from this branch:
uvx 'git+https://github.com/airbytehq/builder-mcp.git@devin/1754081872-add-connector-builder-docs#egg=airbyte-builder-mcp' --helpHelpful Resources
PR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new get_connector_builder_docs() function that provides comprehensive documentation guidance for Airbyte connector development, serving as a documentation tool for LLM agents building low-code YAML-based connectors.
- Implements a documentation retrieval system with high-level overview and topic-specific content
- Adds comprehensive topic mapping covering 25+ Connector Builder UI and YAML reference topics
- Integrates with existing FastMCP tool registration patterns for seamless operation
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| pyproject.toml | Adds requests dependency and types-requests for HTTP documentation fetching |
| builder_mcp/_connector_builder.py | Implements new documentation tool with overview, topic-specific docs, and MCP registration |
- Remove duplicate [project.optional-dependencies] section - Consolidate all dev dependencies in [dependency-groups] section - Use higher version constraints to avoid conflicts - Fixes 'Build and Inspect Python Package' CI check failure Co-Authored-By: AJ Steers <[email protected]>
|
I updated from main to resolve the unrelated ci failure. |
- Remove redundant file_ext parameter from topic mapping tuples - Update tuple structure from (relative_path, file_ext, description) to (relative_path, description) - Derive file extension from relative_path when needed for docs URL construction - Addresses GitHub comment feedback about removing duplication - Maintains all existing functionality while making code more DRY Co-Authored-By: AJ Steers <[email protected]>
…sible - Add TestConnectorBuilderDocs class with parametrized test for all topics - Test verifies HTTP 200 status code for each topic's GitHub raw URL - Helps identify any broken links in the topic mapping - Addresses GitHub comment feedback from @aaronsteers Co-Authored-By: AJ Steers <[email protected]>
|
/autofix
|
1 participant
feat: add get_connector_builder_docs tool for LLM guidance
Summary
This PR adds a new
get_connector_builder_docs()function to the builder-mcp repository that provides documentation guidance for Airbyte connector development. The function serves as a comprehensive documentation tool for LLM agents building low-code YAML-based connectors.Key Features:
Implementation Details:
get_connector_builder_docs()with optional topic parameter_get_high_level_overview()with process steps and tool descriptions_get_topic_specific_docs()with GitHub raw URL fetchingReview & Testing Checklist for Human
get_connector_builder_docs()with no parameters to verify the high-level overview is returned correctlyRecommended Test Plan: Start the MCP server locally and use an MCP client to call the new tool with both overview and specific topic requests to verify full functionality.
Diagram
%%{ init : { "theme" : "default" }}%% graph TD Server["builder_mcp/server.py"]:::context ConnectorBuilder["builder_mcp/_connector_builder.py"]:::major-edit PyProject["pyproject.toml"]:::minor-edit GitHubDocs["GitHub Raw URLs<br/>(airbytehq/airbyte/docs)"]:::context Server -->|"registers tools"| ConnectorBuilder ConnectorBuilder -->|"fetches docs via HTTP"| GitHubDocs PyProject -->|"provides requests dependency"| ConnectorBuilder subgraph "New Functions" GetDocs["get_connector_builder_docs()"]:::major-edit HighLevel["_get_high_level_overview()"]:::major-edit TopicSpecific["_get_topic_specific_docs()"]:::major-edit end ConnectorBuilder --> GetDocs GetDocs --> HighLevel GetDocs --> TopicSpecific TopicSpecific --> GitHubDocs 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:#FFFFFFNotes
Session Details: