Skip to content

docs(readme): compare with hosted Slack connector; document cache TTL/refresh envs - #12

Merged
AlexanderMakarov merged 1 commit into
masterfrom
docs/compare-connector-and-recent-updates
Jul 9, 2026
Merged

docs(readme): compare with hosted Slack connector; document cache TTL/refresh envs#12
AlexanderMakarov merged 1 commit into
masterfrom
docs/compare-connector-and-recent-updates

Conversation

@AlexanderMakarov

@AlexanderMakarov AlexanderMakarov commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

What

Adds a Comparison with the hosted Slack connector section to the README (placed right before the ## Tools section), and brings the docs up to date with recent fork developments.

New comparison section

  • Explains the difference vs. Anthropic's hosted Slack connector: self-hosted binary with your own tokens (xoxc/xoxd stealth, or xoxp/xoxb) vs. a hosted OAuth app.
  • Feature support table — what each side supports (unreads, mark-as-read, saved items, user groups, reaction search here; canvases, scheduling, channel members, emoji search on the connector).
  • Caching table — this server keeps a persistent, TeamID-prefixed, TTL'd on-disk cache of users/channels for @user / #channel resolution; the connector queries the Slack Web API live with no user-managed cache.

Recent-development doc updates (from commit history)

Why

Docs-only. Makes it clear when to reach for this server vs. the hosted connector, and closes gaps between the code and the README for cache configuration.

Summary by CodeRabbit

  • Documentation
    • Expanded the Slack MCP Server feature list to better describe message search, embedded user details, and cache behavior.
    • Added a comparison section with the hosted Slack connector, including a capability table and clearer notes on data freshness and refresh behavior.
    • Updated the quick reference for environment variables with new cache settings, including default values and edge-case handling.

…/refresh envs

Add a 'Comparison with the hosted Slack connector' section before Tools,
covering feature support and how each side caches Slack data.

Also bring the docs up to date with recent fork developments:
- note has:/hasmy: reaction filters in the Search Messages feature
- note rich_text rendering for conversations_add_message payloads
- describe TeamID-prefixed, TTL'd, count-merging cache behavior
- document the SLACK_MCP_CACHE_TTL and SLACK_MCP_MIN_REFRESH_INTERVAL env vars
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README.md was updated to expand the Slack MCP Server feature list with search and cache details, replace the hosted connector comparison section with a capability table and caching explanation, and document two new cache-related environment variables.

Changes

README caching and comparison documentation

Layer / File(s) Summary
Feature list update
README.md
Feature bullets revised to add "Search Messages" and "Embedded user information" entries, and expand cache support description to cover workspace isolation via TeamID, configurable TTL, and background refresh.
Hosted connector comparison section
README.md
New "Comparison with the hosted Slack connector" section added, including a capability comparison table and explanation of on-disk persistent caching vs. hosted connector's live queries, with freshness/refresh semantics and limitations noted.
Cache environment variable reference
README.md
Documentation added for SLACK_MCP_CACHE_TTL and SLACK_MCP_MIN_REFRESH_INTERVAL environment variables, describing TTL/disable and rate-limiting behavior including negative-value handling.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main README changes: the Slack connector comparison and cache TTL/refresh environment docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/compare-connector-and-recent-updates

Warning

Tools execution failed with the following error:

Failed to run tools: 13 INTERNAL: Received RST_STREAM with code 2 (Internal server error)


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 35: The README privacy statement is too absolute and should be softened
to reflect local control rather than guaranteeing data never leaves the machine.
Update the wording in the project overview so it emphasizes that you run the Go
binary yourself, keep ownership of your tokens and configuration, and control
the self-hosted server, while avoiding any claim that Slack data never leaves
the machine; use the surrounding self-hosted vs hosted Slack connector contrast
to guide the rewrite.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ae421d26-a5f6-4fcf-bc54-ed2b592ae163

📥 Commits

Reviewing files that changed from the base of the PR and between e0e1921 and b98fd42.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md

## Comparison with the hosted Slack connector

Claude clients (Claude Code, claude.ai, Claude Desktop) can also reach Slack through Anthropic's **hosted Slack connector** — an OAuth Slack app that Anthropic operates on your behalf. This project takes a different route: you run the Go binary yourself with your own tokens (browser-session `xoxc`/`xoxd` "stealth" mode, or `xoxp`/`xoxb`). Nothing has to be installed or approved in your workspace, and your data never leaves the machine the server runs on.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔒 Security & Privacy | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

# Inspect the relevant README section with line numbers.
git ls-files README.md
wc -l README.md
sed -n '25,45p' README.md | cat -n

Repository: provectus/slack-mcp-server

Length of output: 1975


Tighten the privacy wording here. “Your data never leaves the machine” is too absolute; the self-hosted server still sends Slack data to Slack’s API. Rephrase this as local control/ownership, not data locality.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 35, The README privacy statement is too absolute and
should be softened to reflect local control rather than guaranteeing data never
leaves the machine. Update the wording in the project overview so it emphasizes
that you run the Go binary yourself, keep ownership of your tokens and
configuration, and control the self-hosted server, while avoiding any claim that
Slack data never leaves the machine; use the surrounding self-hosted vs hosted
Slack connector contrast to guide the rewrite.

@AlexanderMakarov
AlexanderMakarov merged commit 4452458 into master Jul 9, 2026
7 checks passed
@AlexanderMakarov
AlexanderMakarov deleted the docs/compare-connector-and-recent-updates branch July 9, 2026 11:13
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