Skip to content

Doc stuff#1259

Merged
tisnik merged 2 commits intolightspeed-core:mainfrom
Akrog:doc-stuff
Mar 3, 2026
Merged

Doc stuff#1259
tisnik merged 2 commits intolightspeed-core:mainfrom
Akrog:doc-stuff

Conversation

@Akrog
Copy link
Contributor

@Akrog Akrog commented Mar 3, 2026

Description

Small doc improvements:

  • One of the Authorization examples incorrectly indicates that the file should have the Bearer section when it shouldn't.
  • There is no mention of how in run.yaml under thee tool_runtime there's a need for the mcp remote provider.

Type of change

  • Documentation Update

Tools used to create PR

Manually written.

Summary by CodeRabbit

  • Documentation
    • Expanded tool configuration documentation with detailed setup instructions
    • Added comprehensive MCP server configuration guide covering authentication methods (tokens, Kubernetes, OAuth) and header propagation
    • Enhanced example configurations demonstrating vector store and MCP tool integration
    • Improved authentication token sample output formatting

Akrog added 2 commits March 3, 2026 10:02
In the README an Authorization example for MCP indicates that the file
should contain the `Bearer` section, but that is incorrect.

If we the file contents are as indicated in the file then the MCP server
will receive the `Authorization` header as `Bearer Bearer
sk-abc123def456...` and fail

This patch fixes this in the README by removing the `Bearer` word in the
file.
We don't document anywhere that for MCP tools to work we need to
configure a `remote::model-context-protocol` provider in `run.yaml`.

This patch adds a very brief mention of this in the README and update
the sample `run.yaml` to reflect this.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 3, 2026

Walkthrough

Documentation expanded to explain MCP server configuration, authentication methods (static tokens, Kubernetes, OAuth, client-provided tokens), and header propagation behavior. Example run.yaml updated with MCP tool provider configuration and vector store identification.

Changes

Cohort / File(s) Summary
Documentation & Configuration
README.md
Expanded MCP Servers section with configuration structure, authentication methods (static tokens, Kubernetes, OAuth, client-provided tokens), header propagation rules, and comprehensive examples for various auth scenarios and server discovery.
Example Configuration
examples/run.yaml
Added model-context-protocol provider entry under tool_runtime and augmented vector store configuration with explicit vector_store_id identifier.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • tisnik
  • VladimirKadlec
  • matysek
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Doc stuff' is vague and generic, using a non-descriptive term that fails to convey the specific changes being made. Replace with a more specific title like 'Fix Authorization example and document MCP tool_runtime configuration' to clearly describe the actual changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
README.md (1)

333-340: Consider adding providers: context to the YAML snippet for copy/paste safety.

The snippet is correct, but showing it nested under providers: would reduce misconfiguration risk for readers skimming the section.

Suggested doc tweak
-```yaml
-  tool_runtime:
-    - provider_id: model-context-protocol
-      provider_type: remote::model-context-protocol
-      config: {}
-```
+```yaml
+providers:
+  tool_runtime:
+    - provider_id: model-context-protocol
+      provider_type: remote::model-context-protocol
+      config: {}
+```
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 333 - 340, Update the YAML example so it's shown
nested under a top-level providers context to avoid copy/paste misconfiguration:
modify the snippet that contains tool_runtime and provider_id:
model-context-protocol (and provider_type: remote::model-context-protocol,
config: {}) to be indented under a new providers: key, i.e. wrap the existing
tool_runtime block inside providers:, ensuring indentation matches the
surrounding examples and the keys tool_runtime, provider_id, provider_type, and
config remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Around line 333-340: Update the YAML example so it's shown nested under a
top-level providers context to avoid copy/paste misconfiguration: modify the
snippet that contains tool_runtime and provider_id: model-context-protocol (and
provider_type: remote::model-context-protocol, config: {}) to be indented under
a new providers: key, i.e. wrap the existing tool_runtime block inside
providers:, ensuring indentation matches the surrounding examples and the keys
tool_runtime, provider_id, provider_type, and config remain unchanged.

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f0647c7 and 1c3392b.

📒 Files selected for processing (2)
  • README.md
  • examples/run.yaml

Copy link
Contributor

@tisnik tisnik left a comment

Choose a reason for hiding this comment

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

LGTM

@tisnik tisnik merged commit f95faa7 into lightspeed-core:main Mar 3, 2026
22 checks passed
@Akrog Akrog deleted the doc-stuff branch March 3, 2026 13:29
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.

2 participants