Improve MCP developer experience#348
Conversation
- Add quick reference section at the top with essential commands - Add detailed example section with callouts explaining each component - Add callout comments directly to weather-service.yaml example - Include links to processor documentation in callout explanations - Show example response JSON to demonstrate tool output - Remove markdown-style bold formatting throughout - Add 'Common mistakes to avoid' section to yaml-config-rules partial - Add NOTE about outputs/inputs containing processors - Add 'output with processors' example to config-examples partial - Add anchor [[outputs-with-processors]] to pipeline-patterns - Improve clarity and navigation for better developer experience
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThis PR adds Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
modules/components/pages/outputs/http_server.adoc (1)
5-5: Consider moving metadata to align with peer pages.The
:page-commercial-names:attribute is placed at the end of the metadata block (line 5), whereas in the corresponding input file (http_server input) and the http_client files (both input and output), it is placed earlier in the metadata block. Moving this to line 3 (after the title, before:type:) would align with the established pattern across similar pages and improve consistency.modules/components/pages/processors/sql_insert.adoc (1)
1-6: Standardize:page-commercial-names:placement across all component documentation pages.The
:page-commercial-names:attribute is placed immediately after the// tag::single-source[]comment (line 3, before:type:) in files likesql_insert.adoc,archive.adoc, andmongodb.adoc, but at the end of the metadata block after:categories:in files likeamqp_1.adocandnats_stream.adoc. Consistent placement across all 75 component files would improve maintainability.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (80)
modules/ai-agents/examples/resources/processors/weather-service.yamlmodules/ai-agents/pages/mcp-server/developer-guide.adocmodules/ai-agents/pages/mcp-server/pipeline-patterns.adocmodules/ai-agents/partials/mcp/config-examples.adocmodules/ai-agents/partials/mcp/yaml-config-rules-connect.adocmodules/components/pages/inputs/amqp_0_9.adocmodules/components/pages/inputs/amqp_1.adocmodules/components/pages/inputs/aws_kinesis.adocmodules/components/pages/inputs/aws_s3.adocmodules/components/pages/inputs/aws_sqs.adocmodules/components/pages/inputs/azure_blob_storage.adocmodules/components/pages/inputs/azure_cosmosdb.adocmodules/components/pages/inputs/azure_queue_storage.adocmodules/components/pages/inputs/azure_table_storage.adocmodules/components/pages/inputs/cassandra.adocmodules/components/pages/inputs/csv.adocmodules/components/pages/inputs/gcp_bigquery_select.adocmodules/components/pages/inputs/gcp_cloud_storage.adocmodules/components/pages/inputs/gcp_pubsub.adocmodules/components/pages/inputs/gcp_spanner_cdc.adocmodules/components/pages/inputs/http_client.adocmodules/components/pages/inputs/http_server.adocmodules/components/pages/inputs/kafka.adocmodules/components/pages/inputs/kafka_franz.adocmodules/components/pages/inputs/mongodb.adocmodules/components/pages/inputs/nats.adocmodules/components/pages/inputs/nats_jetstream.adocmodules/components/pages/inputs/nats_stream.adocmodules/components/pages/inputs/pulsar.adocmodules/components/pages/inputs/redis_list.adocmodules/components/pages/inputs/redis_pubsub.adocmodules/components/pages/inputs/redis_streams.adocmodules/components/pages/inputs/sql_raw.adocmodules/components/pages/inputs/sql_select.adocmodules/components/pages/outputs/amqp_0_9.adocmodules/components/pages/outputs/amqp_1.adocmodules/components/pages/outputs/aws_dynamodb.adocmodules/components/pages/outputs/aws_kinesis.adocmodules/components/pages/outputs/aws_kinesis_firehose.adocmodules/components/pages/outputs/aws_s3.adocmodules/components/pages/outputs/aws_sns.adocmodules/components/pages/outputs/aws_sqs.adocmodules/components/pages/outputs/azure_blob_storage.adocmodules/components/pages/outputs/azure_cosmosdb.adocmodules/components/pages/outputs/azure_data_lake_gen2.adocmodules/components/pages/outputs/azure_queue_storage.adocmodules/components/pages/outputs/azure_table_storage.adocmodules/components/pages/outputs/cassandra.adocmodules/components/pages/outputs/gcp_bigquery.adocmodules/components/pages/outputs/gcp_cloud_storage.adocmodules/components/pages/outputs/gcp_pubsub.adocmodules/components/pages/outputs/http_client.adocmodules/components/pages/outputs/http_server.adocmodules/components/pages/outputs/kafka.adocmodules/components/pages/outputs/kafka_franz.adocmodules/components/pages/outputs/mongodb.adocmodules/components/pages/outputs/nats.adocmodules/components/pages/outputs/nats_jetstream.adocmodules/components/pages/outputs/nats_stream.adocmodules/components/pages/outputs/pulsar.adocmodules/components/pages/outputs/redis_hash.adocmodules/components/pages/outputs/redis_list.adocmodules/components/pages/outputs/redis_pubsub.adocmodules/components/pages/outputs/redis_streams.adocmodules/components/pages/outputs/sql_insert.adocmodules/components/pages/outputs/sql_raw.adocmodules/components/pages/processors/archive.adocmodules/components/pages/processors/aws_bedrock_chat.adocmodules/components/pages/processors/aws_bedrock_embeddings.adocmodules/components/pages/processors/aws_dynamodb_partiql.adocmodules/components/pages/processors/aws_lambda.adocmodules/components/pages/processors/azure_cosmosdb.adocmodules/components/pages/processors/gcp_bigquery_select.adocmodules/components/pages/processors/gcp_vertex_ai_chat.adocmodules/components/pages/processors/gcp_vertex_ai_embeddings.adocmodules/components/pages/processors/mongodb.adocmodules/components/pages/processors/sql_insert.adocmodules/components/pages/processors/sql_raw.adocmodules/components/pages/processors/sql_select.adocmodules/components/pages/processors/unarchive.adoc
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-11-25T10:26:50.930Z
Learnt from: CR
Repo: redpanda-data/rp-connect-docs PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T10:26:50.930Z
Learning: The Redpanda Connect reference documentation uses a two-tier approach combining autogenerated content from source code and schemas with overrides managed in a central DRY (Don't Repeat Yourself) system
Applied to files:
modules/ai-agents/pages/mcp-server/developer-guide.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-connect
- GitHub Check: Header rules - redpanda-connect
- GitHub Check: Pages changed - redpanda-connect
🔇 Additional comments (76)
modules/components/pages/processors/gcp_vertex_ai_chat.adoc (1)
3-3: LGTM!The commercial names metadata is correctly placed and formatted. This addition improves searchability without affecting the documented content or functionality.
modules/components/pages/inputs/csv.adoc (1)
5-5: LGTM!The
page-commercial-namesmetadata addition is correctly formatted in AsciiDoc and the value accurately describes the CSV component for improved searchability and branding.modules/components/pages/processors/gcp_vertex_ai_embeddings.adoc (1)
3-3: LGTM!The commercial names metadata is correctly formatted and appropriately values the processor for searchability. The placement in the AsciiDoc header follows the established pattern and does not affect the processor documentation content or rendering.
modules/components/pages/inputs/gcp_spanner_cdc.adoc (1)
3-3: Metadata field correctly added for commercial naming and discoverability.The
:page-commercial-names:field is properly formatted as AsciiDoc front-matter, and the values "Google Cloud, GCP" are appropriate alternative names for this GCP component. This change aligns with the broader PR objective to enhance searchability across ~60 component pages.Verify that the
:page-commercial-names:metadata field is a recognized field in your documentation system's build process and that the format is consistent across all pages receiving this change. You may want to confirm:
- The field is processed/indexed correctly by your documentation platform (e.g., search indexing, SEO, or site generation)
- The comma-separated format ("Google Cloud, GCP") matches the expected schema across similar GCP/Google Cloud product pages (e.g.,
gcp_bigquery_select,gcp_cloud_storage,gcp_pubsub)modules/components/pages/outputs/pulsar.adoc (1)
5-5: Metadata attribute added correctly.The
:page-commercial-names:attribute is properly formatted as AsciiDoc document metadata and logically placed in the header section alongside other component attributes.Verify that this metadata attribute format and the commercial names list are consistent with other component pages across the ~60 files mentioned in the PR summary.
modules/components/pages/inputs/pulsar.adoc (1)
5-5: Metadata attribute added consistently with output variant.The
:page-commercial-names:attribute matches the corresponding outputs/pulsar.adoc page, which is appropriate since both components reference the same underlying technology.modules/components/pages/outputs/http_client.adoc (1)
3-3: Metadata addition looks good.The commercial names accurately describe the HTTP client component, and the placement is consistent with the corresponding input file.
modules/components/pages/inputs/http_client.adoc (1)
3-3: Metadata addition looks good.Consistent with the corresponding http_client output page.
modules/components/pages/inputs/http_server.adoc (1)
3-3: Metadata addition looks good.The commercial names are appropriate, and the placement is consistent with other input files in the PR.
modules/components/pages/outputs/cassandra.adoc (1)
4-4: Consistent metadata addition across input and output pages.The
page-commercial-namesattribute is correctly formatted and matches the corresponding input page, ensuring consistency across related component documentation.modules/components/pages/inputs/cassandra.adoc (1)
5-5: Metadata addition for searchability looks good.The
page-commercial-namesattribute is correctly formatted and the commercial names for Cassandra are accurate. Verification confirms consistent format across 75 modified pages, with proper comma-separated syntax, capitalization, and no malformed entries. The naming pattern matches similar services (e.g., "Apache Kafka, Kafka").modules/components/pages/outputs/redis_pubsub.adoc (1)
3-3: LGTM!Metadata addition is correctly formatted and consistently placed with other similar changes in the PR.
modules/components/pages/inputs/redis_list.adoc (1)
3-3: LGTM!Metadata addition is correctly formatted and aligns with the corresponding output page.
modules/components/pages/outputs/redis_list.adoc (1)
3-3: LGTM!Metadata addition is correctly formatted and matches the input page.
modules/components/pages/inputs/redis_streams.adoc (1)
3-3: LGTM!Metadata addition is correctly formatted and aligns with the corresponding output page.
modules/components/pages/outputs/redis_streams.adoc (1)
3-3: LGTM!Metadata addition is correctly formatted and matches the input page.
modules/components/pages/inputs/redis_pubsub.adoc (1)
3-3: LGTM!Metadata addition is correctly formatted and aligns with the corresponding output page.
modules/components/pages/outputs/amqp_1.adoc (1)
5-5: Metadata addition is clean and properly formatted.The
:page-commercial-namesattribute follows AsciiDoc conventions and includes appropriate commercial aliases for the AMQP 1.0 component.modules/components/pages/inputs/aws_s3.adoc (1)
3-3: Metadata addition is well-formed with comprehensive commercial name coverage.The four name variants (Amazon S3, AWS S3, S3, Simple Storage Service) provide good search discoverability for this AWS service.
modules/components/pages/outputs/aws_kinesis_firehose.adoc (1)
3-3: Metadata addition is well-formed.The three commercial name variants for Kinesis Firehose are appropriate and cover standard naming conventions.
modules/components/pages/outputs/azure_cosmosdb.adoc (1)
3-3: Metadata addition is properly formatted.The Azure commercial name variants are appropriate for this CosmosDB component.
modules/components/pages/inputs/sql_raw.adoc (1)
3-3: Metadata addition provides comprehensive database/SQL product coverage.The six commercial name variants (SQL, PostgreSQL, MySQL, Microsoft SQL Server, ClickHouse, Trino) appropriately reflect the sql_raw component's cross-database capabilities and improve search discoverability.
modules/components/pages/outputs/mongodb.adoc (1)
3-3: Metadata addition is properly formatted.The MongoDB commercial name variants (MongoDB, Mongo) are appropriate and consistent with standard MongoDB naming conventions.
modules/components/pages/processors/mongodb.adoc (1)
3-3: Metadata addition is properly formatted and consistent with related pages.The commercial names match the MongoDB output page, which is appropriate since both components interface with the same MongoDB service.
modules/components/pages/outputs/nats_jetstream.adoc (1)
3-3: Metadata addition is properly formatted.The NATS commercial name variants (NATS JetStream, NATS) appropriately cover both the specific product feature and its parent messaging system.
modules/components/pages/inputs/mongodb.adoc (1)
3-3: Commercial names are appropriate.The metadata addition for MongoDB with aliases "MongoDB" and "Mongo" is correct and consistent with typical naming conventions for this component.
modules/components/pages/inputs/kafka.adoc (1)
3-3: Commercial names are appropriate.The metadata addition with "Apache Kafka, Kafka" is correct and aligns with standard naming conventions for this component. This also matches the corresponding output component (outputs/kafka.adoc).
modules/components/pages/processors/sql_raw.adoc (1)
3-3: Commercial names are appropriate.The SQL databases and dialects listed (PostgreSQL, MySQL, Microsoft SQL Server, ClickHouse, Trino) are all legitimate targets for this processor and correctly represent commercial names for searchability.
modules/components/pages/processors/sql_select.adoc (1)
3-3: Commercial names are appropriate.The SQL databases and dialects listed match those in the related
sql_rawprocessor and correctly represent commercial names for searchability across SQL-based components.modules/components/pages/inputs/nats_jetstream.adoc (1)
3-3: Commercial names are appropriate.The metadata addition with "NATS JetStream, NATS" correctly represents the commercial names for this messaging component and includes both the specific feature and base product name.
modules/components/pages/outputs/kafka.adoc (1)
3-3: Commercial names are appropriate.The metadata addition with "Apache Kafka, Kafka" is consistent with the corresponding input component (inputs/kafka.adoc) and correctly represents commercial naming for this output.
modules/components/pages/outputs/kafka_franz.adoc (1)
3-3: Commercial names are appropriate.The metadata addition with "Apache Kafka, Kafka" correctly represents this Kafka output variant using the Franz client library and aligns with commercial naming across other Kafka components.
modules/components/pages/outputs/nats.adoc (1)
3-3: Metadata addition looks good—verify build system support.The
:page-commercial-names:field has been added consistently. Ensure that your documentation build system recognizes and properly processes this attribute for search/branding purposes.modules/components/pages/outputs/gcp_bigquery.adoc (1)
3-3: Metadata addition is consistent and comprehensive.The commercial names cover the primary name, the GCP-specific variant, and the short form. Good coverage for search discoverability.
modules/components/pages/processors/aws_bedrock_chat.adoc (1)
3-3: Metadata addition follows established pattern.The names are appropriate for the AWS Bedrock Chat service.
modules/components/pages/inputs/aws_sqs.adoc (1)
3-3: Excellent name coverage for search discoverability.The four variants (full name, vendor+service, service-prefix variants, and acronym) provide comprehensive coverage.
modules/components/pages/outputs/gcp_cloud_storage.adoc (1)
3-3: Metadata addition is complete and consistent.The name variants cover full name, acronym, and GCP-specific variant.
modules/components/pages/outputs/aws_sqs.adoc (1)
3-3: Metadata correctly mirrors the input variant.The same name variants are used for both the input and output SQS components, which ensures consistency across the documentation.
modules/components/pages/outputs/azure_data_lake_gen2.adoc (1)
3-3: Metadata addition is appropriate for Azure service.Two primary variants (vendor+product, short form) are sufficient for Azure naming conventions.
modules/components/pages/processors/archive.adoc (1)
3-3: Format-focused naming is appropriate for this utility processor.The commercial names appropriately reference the specific archive formats (ZIP, TAR, GZIP) that this processor handles, plus the generic "Archive" term for discoverability.
modules/components/pages/inputs/gcp_cloud_storage.adoc (1)
3-3: Metadata addition is well-structured.Commercial names support searchability and branding without affecting documentation content or behavior.
modules/components/pages/inputs/azure_blob_storage.adoc (1)
3-3: Commercial names metadata is appropriate.Azure naming follows expected service terminology for improved search coverage.
modules/components/pages/inputs/gcp_pubsub.adoc (1)
3-3: GCP Pub/Sub commercial names are comprehensive.Multiple naming variants support discoverability across different search contexts.
modules/components/pages/outputs/aws_s3.adoc (1)
3-3: S3 commercial names cover all common search terms.Includes formal name, acronyms, and expanded form for maximum discoverability.
modules/components/pages/outputs/sql_raw.adoc (1)
3-3: SQL commercial names span all supported database systems.Listing specific dialects/systems aids users searching for their particular database type.
modules/components/pages/inputs/sql_select.adoc (1)
3-3: SQL commercial names are consistent across input variant.Matching the naming across input/output/processor variants ensures uniform discoverability.
modules/components/pages/processors/azure_cosmosdb.adoc (1)
3-3: Azure CosmosDB commercial names are appropriately scoped.Platform-level naming supports discovery within broader Azure ecosystem search.
modules/components/pages/processors/aws_lambda.adoc (1)
3-3: Lambda commercial names cover all standard naming conventions.Formal name, AWS-prefixed variant, and shorthand ensure broad search coverage.
modules/components/pages/outputs/gcp_pubsub.adoc (1)
3-3: LGTM — metadata enhancement for searchability.The commercial names are well-chosen variants that reflect how users might search for this GCP service (full official name, GCP acronym, Google branding).
modules/components/pages/outputs/azure_queue_storage.adoc (1)
3-3: LGTM — consistent metadata pattern.Commercial names cover the primary service name and the Microsoft branding variant, aiding discoverability.
modules/components/pages/inputs/kafka_franz.adoc (1)
3-3: LGTM — concise metadata for deprecated component.The two variants effectively cover how users reference this service, appropriate for a deprecated component.
modules/components/pages/outputs/azure_blob_storage.adoc (1)
3-3: LGTM — aligned metadata enrichment.Variants cover both the specific service name and the broader Azure/Microsoft branding context.
modules/components/pages/inputs/nats.adoc (1)
3-3: LGTM — dual naming coverage.Both the acronym and domain-qualified variants (NATS.io) are searchable forms users may employ.
modules/components/pages/inputs/aws_kinesis.adoc (1)
3-3: LGTM — comprehensive AWS service naming.Three variants capture the official name, AWS product branding, and common shorthand—good coverage for discoverability.
modules/components/pages/outputs/aws_kinesis.adoc (1)
3-3: LGTM — consistent input/output naming.Naming mirrors the corresponding input component, maintaining searchability alignment across paired components.
modules/components/pages/outputs/aws_sns.adoc (1)
3-3: LGTM — extensive naming coverage.Four variants provide broad discoverability across formal names, acronyms, and the expanded service description (SNS = Simple Notification Service), maximizing search matches.
modules/components/pages/outputs/aws_dynamodb.adoc (1)
3-3: ✓ Commercial names metadata added correctly.The page-commercial-names attribute is properly formatted and the alternative names are appropriate and specific to the DynamoDB service.
modules/components/pages/processors/aws_bedrock_embeddings.adoc (1)
3-3: Consider narrowing the commercial names scope.The names "Amazon" and "AWS" are extremely broad and apply to many unrelated AWS services. Including them could cause excessive false matches in search/discovery. Consider limiting the list to more specific terms like "AWS Bedrock" or "Bedrock Embeddings" to maintain useful search filtering.
Is the broad inclusion of "Amazon" and "AWS" intentional for maximum discoverability, or would more specific terms be preferred?
modules/components/pages/inputs/azure_cosmosdb.adoc (1)
3-3: ✓ Commercial names metadata added correctly.The page-commercial-names attribute uses appropriate and specific alternative names for Azure CosmosDB.
modules/components/pages/inputs/azure_queue_storage.adoc (1)
3-3: ✓ Commercial names metadata added correctly.The alternative names are specific and appropriate for Azure Queue Storage.
modules/components/pages/outputs/sql_insert.adoc (1)
3-3: Reconsider the commercial names list—too broad and conflating.The entry includes "SQL" (extremely generic) and lists multiple distinct database systems (PostgreSQL, MySQL, Microsoft SQL Server, ClickHouse, Trino). This conflates a database-agnostic SQL insert component with vendor-specific implementations and will create excessive false matches in search.
Consider either:
- Removing very broad terms like "SQL" and generic database names, or
- Clarifying in documentation that this component supports multiple databases generically.
Is
sql_inserttruly database-agnostic, or should the commercial names be narrowed to reflect its actual use cases?modules/components/pages/processors/gcp_bigquery_select.adoc (1)
3-3: ✓ Commercial names metadata added correctly.The alternative names are appropriately specific to Google Cloud BigQuery.
modules/components/pages/inputs/nats_stream.adoc (1)
1-5: ⚠ Inconsistent placement of page-commercial-names attribute.In this file,
:page-commercial-names:is placed in the general metadata section (line 5, after:categories:), whereas all other component pages place it immediately after the// tag::single-source[]marker (line 2). This inconsistency could cause the build system to misprocess the attribute or fail to recognize it.Align the placement by moving the attribute to line 3 (immediately after the single-source tag), consistent with other files.
modules/components/pages/inputs/amqp_0_9.adoc (1)
3-3: ✓ Commercial names metadata added correctly.The alternative names are appropriately specific to the AMQP protocol and RabbitMQ.
modules/components/pages/inputs/amqp_1.adoc (1)
1-5: Verify placement consistency with similarly-structured pages.This file places
:page-commercial-names:at the end of the attribute block (line 5), while pages with a// tag::single-source[]comment place it immediately after the comment, before:type:. Ensure all component pages follow a consistent placement pattern.modules/ai-agents/partials/mcp/yaml-config-rules-connect.adoc (2)
27-34: LGTM! Clear and actionable guidance.The "Common mistakes to avoid" section provides specific, actionable guidance for developers. The examples are concrete and will help prevent common configuration errors.
35-35: LGTM! Helpful clarification with valid cross-reference.The NOTE appropriately clarifies that processors can be nested within outputs/inputs, addressing a common source of confusion. The cross-reference to the new example section is valid.
modules/ai-agents/pages/mcp-server/pipeline-patterns.adoc (2)
29-29: LGTM! Improved consistency.Removing bold formatting from these bullets improves readability and maintains consistent styling throughout the document.
Also applies to: 31-31, 47-47, 49-49, 62-62, 64-64, 85-85, 87-87, 99-99, 101-101, 114-114, 116-116, 127-127, 129-129, 152-152, 154-154, 165-165, 167-167, 180-180, 182-182, 219-219, 221-221
93-108: LGTM! Valuable addition to documentation.This new section clearly explains when and how to use processors within outputs, addresses a common configuration pattern, and provides appropriate use cases. The anchor [[outputs-with-processors]] correctly supports the cross-reference from yaml-config-rules-connect.adoc.
modules/ai-agents/partials/mcp/config-examples.adoc (2)
51-73: LGTM! Clear example of output with processors pattern.This example effectively demonstrates the processors-within-output pattern discussed in the related documentation. The env-cloud conditionals ensure cross-deployment compatibility, and the callout clearly explains the pattern's validity.
89-100: LGTM! Improved clarity with annotations.The updated label specifying "top-level component types" and the added callout markers make the error pattern more explicit and easier to understand. This aligns well with the guidance added to yaml-config-rules-connect.adoc.
modules/ai-agents/examples/resources/processors/weather-service.yaml (2)
3-3: LGTM! Proper annotation for documentation.The callout markers are correctly placed and correspond to the explanations in developer-guide.adoc, making the example easier to understand in the documentation context.
Also applies to: 15-15, 17-17, 23-23, 38-38, 51-51
23-33: All field names in the weather payload are correct and match the wttr.in API response structure. The code accurately accessestemp_C,temp_F,FeelsLikeC,humidity,weatherDesc(as an array withvalueproperty), andwindspeedKmph. No changes needed.Likely an incorrect or invalid review comment.
modules/ai-agents/pages/mcp-server/developer-guide.adoc (3)
6-10: LGTM! Proper use of custom tip caption.The temporary tip caption customization is correctly implemented and appropriately directs new users to the quickstart guide.
12-71: LGTM! Excellent quick reference for developers.The quick reference section provides a clear, step-by-step command sequence from initialization to client connection. The example tool with callouts and the corresponding JSON response effectively demonstrate the complete workflow. The commands are correct and the cross-references are valid.
160-165: LGTM! Clear and actionable best practices.The updated formatting improves consistency with the related pipeline-patterns documentation, and the guidance remains clear and specific.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
- Reorganize into standard topic types: overview, concepts, best-practices, reference, tool-patterns, troubleshooting - Add single-sourcing partials for sharing content with cloud-docs - Add comprehensive examples for input validation, error handling, response formatting, and MCP metadata design - Add secrets (environment variables) and tags documentation to reference - Simplify quickstart to focus on getting started quickly - Move conceptual content from quickstart to dedicated concepts page - Add debugging techniques and troubleshooting guides
- Add key-terms.adoc partial for single-sourcing between repos - Remove duplicate execution model content from mcp-tools-concept.adoc - Fix conditional-processing.yaml to use actual parsing with parse_json/parse_csv - Update concepts.adoc to use key-terms partial
- Add 'Test your tools' section with curl/SSE testing workflow - Fix bounded vs unbounded reads terminology - Minor improvements to concepts and component documentation
Update persona attributes to use IDs defined in personas.yaml: - streaming_platform_developer → streaming_developer - platform_engineer_sre → platform_operator - data_engineer_pipeline_architect → data_engineer - ai_product_builder → evaluator
…rp-connect-docs into improve-mcp-devex
…rp-connect-docs into improve-mcp-devex
Co-authored-by: Michele Cyran <michele@redpanda.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
micheleRP
left a comment
micheleRP
left a comment
There was a problem hiding this comment.
see latest comments, then lgtm!
3 participants
Description
Restructured MCP documentation to improve navigation, reduce redundancy, and align content with user learning goals. This work addresses negative feedback about the documentation UX by evaluating and improving the information architecture.
Motivation
User feedback indicated the MCP documentation was difficult to navigate:
Changes
Information architecture improvements
Consistent page structure across all MCP pages:
Removed redundancy:
tool-best-practices.adocpartial (content duplicated in other sections)config-examples.adocpartial (content integrated into YAML rules)Fixed navigation:
Files deleted
modules/ai-agents/partials/mcp/tool-best-practices.adoc(redundant)modules/ai-agents/partials/mcp/config-examples.adoc(integrated elsewhere)example-*.yamlplaceholder filesPage previews
Checks