Skip to content

Commit 561daeb

Browse files
authored
chore(docs): Add one-click install and more IDE install examples (#27)
1 parent 83aa919 commit 561daeb

File tree

1 file changed

+56
-11
lines changed

1 file changed

+56
-11
lines changed

README.md

Lines changed: 56 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<a href="https://pypi.org/project/strands-agents-mcp-server/"><img alt="PyPI version" src="https://img.shields.io/pypi/v/strands-agents-mcp-server"/></a>
2222
<a href="https://python.org"><img alt="Python versions" src="https://img.shields.io/pypi/pyversions/strands-agents-mcp-server"/></a>
2323
</div>
24-
24+
2525
<p>
2626
<a href="https://strandsagents.com/">Documentation</a>
2727
◆ <a href="https://github.com/strands-agents/samples">Samples</a>
@@ -52,6 +52,35 @@ You can use the Strands Agents MCP server with
5252
[40+ applications that support MCP servers](https://modelcontextprotocol.io/clients),
5353
including Amazon Q Developer CLI, Anthropic Claude Code, Cline, and Cursor.
5454

55+
Get started quickly with one-click installation buttons for popular MCP clients. Click the buttons below to install servers directly in your IDE:
56+
57+
[![Install in Kiro](https://img.shields.io/badge/Install-Kiro-9046FF?style=for-the-badge&logo=kiro)](https://kiro.dev/launch/mcp/add?name=strands-agents&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22strands-agents-mcp-server%22%5D%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%22search_docs%22%2C%22fetch_doc%22%5D%7D)
58+
[![Install in Cursor](https://img.shields.io/badge/Install-Cursor-blue?style=for-the-badge&logo=cursor)](https://cursor.com/en-US/install-mcp?name=strands-agents&config=eyJjb21tYW5kIjoidXZ4IHN0cmFuZHMtYWdlbnRzLW1jcC1zZXJ2ZXIifQ%3D%3D)
59+
[![Install in VS Code](https://img.shields.io/badge/Install-VS_Code-FF9900?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect?url=vscode:mcp/install?%7B%22name%22%3A%22strands-agents%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22strands-agents-mcp-server%22%5D%7D)
60+
61+
### Kiro example
62+
63+
See the [Kiro documentation](https://kiro.dev/docs/mcp/configuration/)
64+
for instructions on managing MCP configuration.
65+
66+
In `~/.kiro/settings/mcp.json`:
67+
68+
```json
69+
{
70+
"mcpServers": {
71+
"strands-agents": {
72+
"command": "uvx",
73+
"args": ["strands-agents-mcp-server"],
74+
"env": {
75+
"FASTMCP_LOG_LEVEL": "INFO"
76+
},
77+
"disabled": false,
78+
"autoApprove": ["search_docs", "fetch_doc"]
79+
}
80+
}
81+
}
82+
```
83+
5584
### Q Developer CLI example
5685

5786
See the [Q Developer CLI documentation](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-configuration.html)
@@ -69,10 +98,7 @@ In `~/.aws/amazonq/mcp.json`:
6998
"FASTMCP_LOG_LEVEL": "INFO"
7099
},
71100
"disabled": false,
72-
"autoApprove": [
73-
"search_docs",
74-
"fetch_doc"
75-
]
101+
"autoApprove": ["search_docs", "fetch_doc"]
76102
}
77103
}
78104
}
@@ -117,10 +143,25 @@ In `~/.cursor/mcp.json`:
117143
"FASTMCP_LOG_LEVEL": "INFO"
118144
},
119145
"disabled": false,
120-
"autoApprove": [
121-
"search_docs",
122-
"fetch_doc"
123-
]
146+
"autoApprove": ["search_docs", "fetch_doc"]
147+
}
148+
}
149+
}
150+
```
151+
152+
### VS Code example
153+
154+
See the [VS Code documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers)
155+
for instructions on managing MCP configuration.
156+
157+
In your `mcp.json` file:
158+
159+
```json
160+
{
161+
"servers": {
162+
"strands-agents": {
163+
"command": "uvx",
164+
"args": ["strands-agents-mcp-server"]
124165
}
125166
}
126167
}
@@ -138,25 +179,28 @@ npx @modelcontextprotocol/inspector uvx strands-agents-mcp-server
138179
npx @modelcontextprotocol/inspector python -m strands_mcp_server
139180
```
140181

141-
Note: This requires [npx](https://docs.npmjs.com/cli/v11/commands/npx) to be installed on your system. It comes bundled with [Node.js](https://nodejs.org/).
182+
Note: This requires [npx](https://docs.npmjs.com/cli/v11/commands/npx) to be installed on your system. It comes bundled with [Node.js](https://nodejs.org/).
142183

143184
The Inspector is also useful for troubleshooting MCP server issues as it provides detailed connection and protocol information. For an in-depth guide, have a look at the [MCP Inspector documentation](https://modelcontextprotocol.io/docs/tools/inspector).
144185

145186
## Getting Started
146187

147188
1. **Install prerequisites**:
189+
148190
- Install [uv](https://github.com/astral-sh/uv) following the [official installation instructions](https://github.com/astral-sh/uv#installation)
149191
- Make sure you have [Node.js](https://nodejs.org/) installed for npx commands
150192

151193
2. **Configure your MCP client**:
194+
152195
- Choose your preferred MCP client from the installation examples above
153196
- Add the Strands Agents MCP server configuration to your client
154197

155198
3. **Test the connection**:
199+
156200
```bash
157201
# For published package
158202
npx @modelcontextprotocol/inspector uvx strands-agents-mcp-server
159-
203+
160204
# For local development
161205
npx @modelcontextprotocol/inspector python -m strands_mcp_server
162206
```
@@ -181,6 +225,7 @@ npx @modelcontextprotocol/inspector python -m strands_mcp_server
181225
## Contributing ❤️
182226

183227
We welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) for details on:
228+
184229
- Reporting bugs & features
185230
- Development setup
186231
- Contributing via Pull Requests

0 commit comments

Comments
 (0)