Skip to content

Commit e353c28

Browse files
authored
Revise README for clarity and additional details
Updated README to clarify functionality and usage.
1 parent 7dd1236 commit e353c28

1 file changed

Lines changed: 5 additions & 14 deletions

File tree

README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# Slack CLI
1+
# Slack CLI & MPC Server
22

3-
A Slack CLI that allows you to send Slack messages. Inspired by the GitHub CLI, it aims to provide a simple and efficient way to interact with Slack from the command line, without the need to install a runtime such as Node.js or Python.
3+
A Slack CLI and MCP server that allows you to send Slack messages. Inspired by the GitHub CLI, it aims to provide a simple and efficient way for humans and AI to interact with Slack from the command line or via MPC.
4+
5+
Like `jq`, it is packaged in a tiny (10Mb) binary, without the need to install a runtime such as Node.js or Python, and securely stores your secret in the key-ring, rather than in plain-text.
46

57
It's aimed at coding agents with a very simple interface, and is not intended to be a full-featured Slack client.
68

@@ -29,17 +31,6 @@ export SLACK_TOKEN="xoxb-your-slack-token"
2931

3032
**Note:** Using the keyring is more secure in multi-user systems as environment variables are visible in the process list.
3133

32-
33-
## Prompt
34-
35-
Add this to your prompt (e.g. `AGENTS.md`):
36-
37-
```markdown
38-
- You can send messages to a Slack user by using the `slack send-message <channel|email> "<message>"` command.
39-
- The message supports Markdown formatting which will be automatically converted to Slack's Mrkdwn format.
40-
- For AI assistants supporting MCP (Model Context Protocol), you can use `slack mcp-server` to enable tool-based Slack integration.
41-
```
42-
4334
## Usage
4435

4536
### Direct CLI Usage
@@ -58,7 +49,7 @@ slack send-message alex_collins@intuit.com "I love this tool! It makes Slack int
5849

5950
### MCP Server Mode
6051

61-
The MCP (Model Context Protocol) server allows AI assistants and other tools to interact with Slack through a standardized JSON-RPC protocol over stdio. This enables seamless integration with AI coding assistants and other automation tools.
52+
The MCP (Model Context Protocol) server allows AI assistants and other tools to interact with Slack. This enables seamless integration with AI coding assistants and other automation tools.
6253

6354
**Setup:**
6455

0 commit comments

Comments
 (0)