Skip to content

Commit 8e264ef

Browse files
committed
chore: update readme
1 parent a54a0fc commit 8e264ef

File tree

1 file changed

+62
-52
lines changed

1 file changed

+62
-52
lines changed

README.md

Lines changed: 62 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,17 @@ This is a MCP server that allows you to provide test results context to your AI
3030

3131
Get a Currents API key by following the [instructions here](https://docs.currents.dev/resources/api/api-keys).
3232

33-
### Usage with Cursor Editor
33+
### Usage with Cursor
3434

3535
1. Go to Cursor Settings > MCP > Enable
3636
2. Add the following to your `mcp.json`.
3737

38-
### NPX
39-
4038
```json
4139
{
4240
"mcpServers": {
4341
"currents": {
4442
"command": "npx",
45-
"args": [
46-
"-y",
47-
"@currents/mcp"
48-
],
43+
"args": ["-y", "@currents/mcp"],
4944
"env": {
5045
"CURRENTS_API_KEY": "your-api-key"
5146
}
@@ -54,21 +49,22 @@ Get a Currents API key by following the [instructions here](https://docs.current
5449
}
5550
```
5651

57-
### Usage with Claude Desktop
52+
### Claude
5853

59-
Add the following to your `claude_desktop_config.json`:
54+
Run this command to add Currents MCP to Claude Code
6055

61-
#### NPX
56+
```bash
57+
claude mcp add --transport stdio currents --env CURRENTS_API_KEY=<KEY> -- npx -y @currents/mcp
58+
```
59+
60+
Add the following to enable Currents MCP on Claude Desktop (edit `claude_desktop_config.json` file):
6261

6362
```json
6463
{
6564
"mcpServers": {
6665
"currents": {
6766
"command": "npx",
68-
"args": [
69-
"-y",
70-
"@currents/mcp"
71-
],
67+
"args": ["-y", "@currents/mcp"],
7268
"env": {
7369
"CURRENTS_API_KEY": "your-api-key"
7470
}
@@ -87,30 +83,41 @@ We welcome contributions of all kinds—bug fixes, features, and documentation u
8783

8884
### Quick Start
8985

90-
1. Fork this repository and clone your fork:
91-
```bash
92-
git clone https://github.com/<your-username>/currents-mcp.git
93-
cd currents-mcp
94-
```
95-
2. Install dependencies:
96-
```bash
97-
cd mcp-server
98-
npm install
99-
```
100-
3. Build the project:
101-
```bash
102-
npm run build
103-
```
104-
4. Run tests:
105-
```bash
106-
npm test
107-
```
108-
See [TESTING.md](./mcp-server/TESTING.md) for more details on testing.
109-
5. Run locally (stdio):
110-
```bash
111-
npm start
112-
```
113-
You should see: `Currents MCP Server running on stdio`.
86+
- Fork this repository and clone your fork:
87+
88+
```bash
89+
git clone https://github.com/<your-username>/currents-mcp.git
90+
cd currents-mcp
91+
```
92+
93+
- Install dependencies:
94+
95+
```bash
96+
cd mcp-server
97+
npm install
98+
```
99+
100+
- Build the project:
101+
102+
```bash
103+
npm run build
104+
```
105+
106+
- Run tests:
107+
108+
```bash
109+
npm test
110+
```
111+
112+
See [TESTING.md](./mcp-server/TESTING.md) for more details on testing.
113+
114+
- Run locally (stdio):
115+
116+
```bash
117+
npm start
118+
```
119+
120+
You should see: `Currents MCP Server running on stdio`.
114121

115122
### Local Development with a Client (optional)
116123

@@ -147,33 +154,36 @@ To test the tools locally without any LLM, you can use the following command:
147154
then run the tools script:
148155

149156
```bash
150-
node scripts/call-tools.js
157+
node scripts/call-tools.js
151158
```
152159

153160
### Making Changes
154161

155-
- Create a feature branch:
156-
```bash
157-
git checkout -b feat/short-description
158-
```
159162
- Make changes under `mcp-server/src/`, then rebuild and re-run:
160-
```bash
161-
npm run build && npm start
162-
```
163+
164+
```bash
165+
npm run build && npm start
166+
```
167+
163168
- Write tests for your changes in `*.test.ts` files alongside your code
169+
164170
- Run tests to ensure everything works:
165-
```bash
166-
npm test
167-
```
171+
172+
```bash
173+
npm test
174+
```
175+
168176
- Keep changes focused and documented (add comments/types where helpful).
169177

170178
### Commit and PR Guidelines
171179

172180
- Write clear commit messages (e.g., “fix: handle missing env vars” or “feat: add get-run tool filters”).
173181
- Push your branch and open a Pull Request:
174-
```bash
175-
git push origin feat/short-description
176-
```
182+
183+
```bash
184+
git push origin feat/short-description
185+
```
186+
177187
- In your PR, describe the motivation, approach, and any trade-offs. Link related issues if applicable.
178188

179189
### Reporting Issues

0 commit comments

Comments
 (0)