Skip to content

Commit bf3c5c5

Browse files
committed
docs: improve configuration documentation and remove unused dependencies
- Add comprehensive configuration guides for Claude Code, Claude Desktop, Cursor, and Windsurf - Create detailed wiki-style getting started guides in docs/ directory - Add Quick Start section for immediate setup - Remove unused dependencies (@browserbasehq/stagehand and mcp-proxy) - Update installation instructions to emphasize npx usage - Add table of contents with links to detailed guides - Include troubleshooting sections for common issues - Follow best practices from mobile-mcp documentation structure
1 parent 161f3c3 commit bf3c5c5

File tree

5 files changed

+621
-46
lines changed

5 files changed

+621
-46
lines changed

README.md

Lines changed: 213 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,53 @@
77

88
An MCP (Model Context Protocol) server that provides access to Bing Webmaster Tools functionality through Claude and other MCP-compatible AI assistants.
99

10+
## 🚀 Quick Start
11+
12+
### For Claude Code Users:
13+
```bash
14+
# Add the MCP server
15+
claude mcp add bing-webmaster -- npx -y @isiahw1/mcp-server-bing-webmaster@latest
16+
17+
# Set your API key
18+
export BING_WEBMASTER_API_KEY="your_api_key_here"
19+
20+
# Launch Claude Code
21+
claude
22+
```
23+
24+
### For Claude Desktop Users:
25+
Add to your configuration (Settings → Developer → Edit Config):
26+
```json
27+
{
28+
"mcpServers": {
29+
"bing-webmaster": {
30+
"command": "npx",
31+
"args": ["-y", "@isiahw1/mcp-server-bing-webmaster@latest"],
32+
"env": {
33+
"BING_WEBMASTER_API_KEY": "your_api_key_here"
34+
}
35+
}
36+
}
37+
}
38+
```
39+
40+
[Get your API key from Bing Webmaster Tools](https://www.bing.com/webmasters) → Settings → API Access
41+
42+
## Table of Contents
43+
- [Features](#features)
44+
- [Installation](#installation)
45+
- [Configuration](#configuration)
46+
- [Claude Code](#claude-code-command-line) ([Detailed Guide](docs/getting-started-claude-code.md))
47+
- [Claude Desktop](#claude-desktop) ([Detailed Guide](docs/getting-started-claude-desktop.md))
48+
- [Cursor](#cursor)
49+
- [Windsurf](#windsurf)
50+
- [Development Setup](#development-setup-local-installation)
51+
- [Available Tools](#available-tools-42-total)
52+
- [Usage Examples](#usage-examples)
53+
- [Development](#development)
54+
- [Contributing](#contributing)
55+
- [Support](#support)
56+
1057
## Features
1158

1259
- 🚀 **Direct API Integration**: Simple and reliable access to Bing Webmaster Tools
@@ -18,19 +65,27 @@ An MCP (Model Context Protocol) server that provides access to Bing Webmaster To
1865
## Installation
1966

2067
### Prerequisites
21-
- Python 3.10 or higher
22-
- Bing Webmaster API key (get it from [Bing Webmaster Tools](https://www.bing.com/webmasters))
68+
- Node.js 16+ (for npm/npx)
69+
- Python 3.10+ (installed automatically via npm)
70+
- Bing Webmaster API key ([Get your API key](https://www.bing.com/webmasters))
71+
72+
### Quick Start
73+
The easiest way to use this MCP server is through npx (no installation required):
74+
```bash
75+
npx @isiahw1/mcp-server-bing-webmaster@latest
76+
```
2377

24-
### Option 1: Install from npm
78+
### Global Installation (Optional)
2579
```bash
2680
npm install -g @isiahw1/mcp-server-bing-webmaster
2781
```
2882

29-
### Option 2: Install from source
83+
### Development Installation
84+
For contributors and developers:
3085
```bash
3186
git clone https://github.com/isiahw1/mcp-server-bing-webmaster.git
3287
cd mcp-server-bing-webmaster
33-
pip install -e .
88+
uv pip install -e .
3489
```
3590

3691
## Configuration
@@ -41,23 +96,58 @@ pip install -e .
4196
2. Go to Settings → API Access
4297
3. Generate your API key
4398

44-
### 2. Set up environment
99+
### 2. Client Setup Instructions
100+
101+
<details>
102+
<summary><b>Claude Code (Command Line)</b></summary>
103+
104+
#### Option 1: Quick Setup
105+
```bash
106+
# Add the MCP server to Claude Code
107+
claude mcp add bing-webmaster -- npx -y @isiahw1/mcp-server-bing-webmaster@latest
108+
109+
# Set your API key
110+
export BING_WEBMASTER_API_KEY="your_api_key_here"
111+
112+
# Launch Claude Code
113+
claude
114+
```
115+
116+
#### Option 2: Using Environment File
117+
```bash
118+
# Create .env file
119+
echo "BING_WEBMASTER_API_KEY=your_api_key_here" > .env
120+
121+
# Add the MCP server
122+
claude mcp add bing-webmaster -- npx -y @isiahw1/mcp-server-bing-webmaster@latest
45123

46-
Create a `.env` file in your project directory:
124+
# Launch Claude Code
125+
claude
126+
```
47127

128+
#### Troubleshooting
129+
If you encounter issues, run with debug mode:
48130
```bash
49-
BING_WEBMASTER_API_KEY=your_api_key_here
131+
claude --mcp-debug
50132
```
51133

52-
### 3. Configure Claude Desktop
134+
</details>
135+
136+
<details>
137+
<summary><b>Claude Desktop</b></summary>
53138

54-
Add to your Claude Desktop configuration (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
139+
1. Open Claude Desktop
140+
2. Go to `Claude → Settings`
141+
3. Select `Developer` from the sidebar
142+
4. Click `Edit Config`
143+
5. Add the following to your configuration:
55144

56145
```json
57146
{
58147
"mcpServers": {
59148
"bing-webmaster": {
60-
"command": "mcp-server-bing-webmaster",
149+
"command": "npx",
150+
"args": ["-y", "@isiahw1/mcp-server-bing-webmaster@latest"],
61151
"env": {
62152
"BING_WEBMASTER_API_KEY": "your_api_key_here"
63153
}
@@ -66,14 +156,30 @@ Add to your Claude Desktop configuration (`~/Library/Application Support/Claude/
66156
}
67157
```
68158

69-
For development/source installation:
159+
6. Save the file and restart Claude Desktop
160+
161+
**Configuration file locations:**
162+
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
163+
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
164+
- Linux: `~/.config/Claude/claude_desktop_config.json`
165+
166+
</details>
167+
168+
<details>
169+
<summary><b>Cursor</b></summary>
170+
171+
1. Launch Cursor
172+
2. Open `Cursor → Settings → Cursor Settings`
173+
3. Select `MCP` in the left sidebar
174+
4. Click `Add new global MCP server`
175+
5. Paste this configuration:
70176

71177
```json
72178
{
73179
"mcpServers": {
74180
"bing-webmaster": {
75-
"command": "/path/to/venv/bin/python",
76-
"args": ["-m", "mcp_server_bwt"],
181+
"command": "npx",
182+
"args": ["-y", "@isiahw1/mcp-server-bing-webmaster@latest"],
77183
"env": {
78184
"BING_WEBMASTER_API_KEY": "your_api_key_here"
79185
}
@@ -82,6 +188,99 @@ For development/source installation:
82188
}
83189
```
84190

191+
6. Restart Cursor
192+
193+
</details>
194+
195+
<details>
196+
<summary><b>Windsurf</b></summary>
197+
198+
1. Open Windsurf
199+
2. Navigate to Settings → MCP Configuration
200+
3. Add the following configuration:
201+
202+
```json
203+
{
204+
"mcpServers": {
205+
"bing-webmaster": {
206+
"command": "npx",
207+
"args": ["-y", "@isiahw1/mcp-server-bing-webmaster@latest"],
208+
"env": {
209+
"BING_WEBMASTER_API_KEY": "your_api_key_here"
210+
}
211+
}
212+
}
213+
}
214+
```
215+
216+
4. Restart Windsurf
217+
218+
</details>
219+
220+
<details>
221+
<summary><b>Development Setup (Local Installation)</b></summary>
222+
223+
For developers working with the source code:
224+
225+
```bash
226+
# Clone the repository
227+
git clone https://github.com/isiahw1/mcp-server-bing-webmaster.git
228+
cd mcp-server-bing-webmaster
229+
230+
# Install uv (if not already installed)
231+
curl -LsSf https://astral.sh/uv/install.sh | sh
232+
233+
# Install dependencies
234+
uv pip install -e .
235+
```
236+
237+
#### Claude Desktop Configuration for Development
238+
```json
239+
{
240+
"mcpServers": {
241+
"bing-webmaster-dev": {
242+
"command": "uv",
243+
"args": ["run", "python", "-m", "mcp_server_bwt"],
244+
"cwd": "/path/to/mcp-server-bing-webmaster",
245+
"env": {
246+
"BING_WEBMASTER_API_KEY": "your_api_key_here"
247+
}
248+
}
249+
}
250+
}
251+
```
252+
253+
#### Claude Code Configuration for Development
254+
```bash
255+
# Set environment variable
256+
export BING_WEBMASTER_API_KEY="your_api_key_here"
257+
258+
# Run from the project directory
259+
cd /path/to/mcp-server-bing-webmaster
260+
claude mcp add bing-webmaster-dev -- uv run python -m mcp_server_bwt
261+
```
262+
263+
</details>
264+
265+
### 3. Verify Installation
266+
267+
After configuration, you should be able to:
268+
- See "bing-webmaster" in your MCP servers list
269+
- Use commands like "Show me all my sites in Bing Webmaster Tools"
270+
- Access all 42+ Bing Webmaster Tools functions
271+
272+
### Troubleshooting
273+
274+
**"Could not attach to MCP server" error:**
275+
1. Check your API key is correct
276+
2. Ensure you have internet connectivity
277+
3. For Claude Desktop: Check logs in Settings → Developer → Open Logs Folder
278+
4. For Claude Code: Run with `claude --mcp-debug`
279+
280+
**"spawn mcp-server-bing-webmaster ENOENT" error:**
281+
- Make sure you're using `npx` as the command, not `mcp-server-bing-webmaster`
282+
- If you have an old global installation, uninstall it: `npm uninstall -g @isiahw1/mcp-server-bing-webmaster`
283+
85284
## Available Tools (42 Total)
86285

87286
### Site Management

docs/getting-started-claude-code.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Getting Started with Claude Code
2+
3+
This guide will help you set up the Bing Webmaster Tools MCP server with Claude Code.
4+
5+
## Prerequisites
6+
7+
- Claude Code CLI installed ([Download here](https://claude.ai/code))
8+
- Node.js 16+ installed
9+
- Bing Webmaster API key ([Get it here](https://www.bing.com/webmasters))
10+
11+
## Setup Steps
12+
13+
### 1. Add the MCP Server
14+
15+
Run this command to add the Bing Webmaster MCP server to Claude Code:
16+
17+
```bash
18+
claude mcp add bing-webmaster -- npx -y @isiahw1/mcp-server-bing-webmaster@latest
19+
```
20+
21+
### 2. Set Your API Key
22+
23+
#### Option A: Environment Variable
24+
```bash
25+
export BING_WEBMASTER_API_KEY="your_api_key_here"
26+
```
27+
28+
#### Option B: Using .env File
29+
Create a `.env` file in your project directory:
30+
```
31+
BING_WEBMASTER_API_KEY=your_api_key_here
32+
```
33+
34+
### 3. Launch Claude Code
35+
36+
```bash
37+
claude
38+
```
39+
40+
## Verify Installation
41+
42+
Once launched, try these commands to verify the setup:
43+
44+
```
45+
"Show me all my sites in Bing Webmaster Tools"
46+
"What's my URL submission quota?"
47+
```
48+
49+
## Troubleshooting
50+
51+
### Enable Debug Mode
52+
If you're experiencing issues, run Claude Code with debug logging:
53+
```bash
54+
claude --mcp-debug
55+
```
56+
57+
### Common Issues
58+
59+
**"Cannot find MCP server" error:**
60+
- Ensure you've run the `claude mcp add` command
61+
- Check that Node.js is installed: `node --version`
62+
63+
**"Invalid API key" error:**
64+
- Verify your API key is correct
65+
- Make sure the environment variable is set: `echo $BING_WEBMASTER_API_KEY`
66+
67+
**"spawn ENOENT" error:**
68+
- This usually means npx can't be found
69+
- Ensure Node.js and npm are in your PATH
70+
71+
### Checking Logs
72+
Look for messages like:
73+
```
74+
MCP server "bing-webmaster" Server stderr: Starting Bing Webmaster MCP server...
75+
```
76+
77+
## Advanced Usage
78+
79+
### Using a Specific Version
80+
```bash
81+
claude mcp add bing-webmaster -- npx -y @isiahw1/[email protected]
82+
```
83+
84+
### Using Local Development Version
85+
```bash
86+
# From your development directory
87+
cd /path/to/mcp-server-bing-webmaster
88+
claude mcp add bing-webmaster-dev -- uv run python -m mcp_server_bwt
89+
```
90+
91+
## Next Steps
92+
93+
- Explore the [full list of available tools](../README.md#available-tools-42-total)
94+
- Check out [usage examples](../README.md#usage-examples)
95+
- Learn about [API quotas and limits](https://www.bing.com/webmaster/help/webmaster-api-limits)
96+
97+
## Support
98+
99+
If you encounter issues:
100+
1. Check the [troubleshooting section](#troubleshooting)
101+
2. Review [GitHub Issues](https://github.com/isiahw1/mcp-server-bing-webmaster/issues)
102+
3. Open a new issue with debug logs

0 commit comments

Comments
 (0)