| Name | surfer-mcp JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | This is the MCP server for Surfer that connects to the Claude Desktop App |
| upload_time | 2024-12-22 03:03:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.13 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# surfer-mcp MCP server
This is the MCP server for Surfer that connects to the Claude Desktop App
## Components
### Resources
The server implements a simple note storage system with:
- Custom note:// URI scheme for accessing individual notes
- Each note resource has a name, description and text/plain mimetype
### Prompts
The server provides a single prompt:
- summarize-notes: Creates summaries of all stored notes
- Optional "style" argument to control detail level (brief/detailed)
- Generates prompt combining all current notes with style preference
### Tools
The server implements one tool:
- add-note: Adds a new note to the server
- Takes "name" and "content" as required string arguments
- Updates server state and notifies clients of resource changes
## Configuration
[TODO: Add configuration details specific to your implementation]
## Quickstart
### Install
#### Claude Desktop
On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
<details>
<summary>Development/Unpublished Servers Configuration</summary>
```
"mcpServers": {
"surfer-mcp": {
"command": "uv",
"args": [
"--directory",
"/Users/sahil/Documents/Surfer-Protocol/surfer-mcp",
"run",
"surfer-mcp"
]
}
}
```
</details>
<details>
<summary>Published Servers Configuration</summary>
```
"mcpServers": {
"surfer-mcp": {
"command": "uvx",
"args": [
"surfer-mcp"
]
}
}
```
</details>
## Development
### Building and Publishing
To prepare the package for distribution:
1. Sync dependencies and update lockfile:
```bash
uv sync
```
2. Build package distributions:
```bash
uv build
```
This will create source and wheel distributions in the `dist/` directory.
3. Publish to PyPI:
```bash
uv publish
```
Note: You'll need to set PyPI credentials via environment variables or command flags:
- Token: `--token` or `UV_PUBLISH_TOKEN`
- Or username/password: `--username`/`UV_PUBLISH_USERNAME` and `--password`/`UV_PUBLISH_PASSWORD`
### Debugging
Since MCP servers run over stdio, debugging can be challenging. For the best debugging
experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:
```bash
npx @modelcontextprotocol/inspector uv --directory /Users/sahil/Documents/Surfer-Protocol/surfer-mcp run surfer-mcp
```
Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.
Raw data
{
"_id": null,
"home_page": null,
"name": "surfer-mcp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Sahil Lalani <99920148+sahil-lalani@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/50/56/12c727f55757d06562932c3be172fc76fc9fb706f6041f5ef26f443fd9b2/surfer_mcp-0.1.1.tar.gz",
"platform": null,
"description": "# surfer-mcp MCP server\n\nThis is the MCP server for Surfer that connects to the Claude Desktop App\n\n## Components\n\n### Resources\n\nThe server implements a simple note storage system with:\n- Custom note:// URI scheme for accessing individual notes\n- Each note resource has a name, description and text/plain mimetype\n\n### Prompts\n\nThe server provides a single prompt:\n- summarize-notes: Creates summaries of all stored notes\n - Optional \"style\" argument to control detail level (brief/detailed)\n - Generates prompt combining all current notes with style preference\n\n### Tools\n\nThe server implements one tool:\n- add-note: Adds a new note to the server\n - Takes \"name\" and \"content\" as required string arguments\n - Updates server state and notifies clients of resource changes\n\n## Configuration\n\n[TODO: Add configuration details specific to your implementation]\n\n## Quickstart\n\n### Install\n\n#### Claude Desktop\n\nOn MacOS: `~/Library/Application\\ Support/Claude/claude_desktop_config.json`\nOn Windows: `%APPDATA%/Claude/claude_desktop_config.json`\n\n<details>\n <summary>Development/Unpublished Servers Configuration</summary>\n ```\n \"mcpServers\": {\n \"surfer-mcp\": {\n \"command\": \"uv\",\n \"args\": [\n \"--directory\",\n \"/Users/sahil/Documents/Surfer-Protocol/surfer-mcp\",\n \"run\",\n \"surfer-mcp\"\n ]\n }\n }\n ```\n</details>\n\n<details>\n <summary>Published Servers Configuration</summary>\n ```\n \"mcpServers\": {\n \"surfer-mcp\": {\n \"command\": \"uvx\",\n \"args\": [\n \"surfer-mcp\"\n ]\n }\n }\n ```\n</details>\n\n## Development\n\n### Building and Publishing\n\nTo prepare the package for distribution:\n\n1. Sync dependencies and update lockfile:\n```bash\nuv sync\n```\n\n2. Build package distributions:\n```bash\nuv build\n```\n\nThis will create source and wheel distributions in the `dist/` directory.\n\n3. Publish to PyPI:\n```bash\nuv publish\n```\n\nNote: You'll need to set PyPI credentials via environment variables or command flags:\n- Token: `--token` or `UV_PUBLISH_TOKEN`\n- Or username/password: `--username`/`UV_PUBLISH_USERNAME` and `--password`/`UV_PUBLISH_PASSWORD`\n\n### Debugging\n\nSince MCP servers run over stdio, debugging can be challenging. For the best debugging\nexperience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).\n\n\nYou can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:\n\n```bash\nnpx @modelcontextprotocol/inspector uv --directory /Users/sahil/Documents/Surfer-Protocol/surfer-mcp run surfer-mcp\n```\n\n\nUpon launching, the Inspector will display a URL that you can access in your browser to begin debugging.",
"bugtrack_url": null,
"license": null,
"summary": "This is the MCP server for Surfer that connects to the Claude Desktop App",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "27689d96b90f7543bf3f0375ddfed7b69f20509e4a3b4e93d35b996f1d8ee144",
"md5": "08b384659cd3a9a7ac962e27e2057857",
"sha256": "e32a29606751ff8d2ae08ae3c6c4e55c472b2f9082f3b8e4db698e2c16e4f991"
},
"downloads": -1,
"filename": "surfer_mcp-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08b384659cd3a9a7ac962e27e2057857",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13",
"size": 4979,
"upload_time": "2024-12-22T03:03:01",
"upload_time_iso_8601": "2024-12-22T03:03:01.189013Z",
"url": "https://files.pythonhosted.org/packages/27/68/9d96b90f7543bf3f0375ddfed7b69f20509e4a3b4e93d35b996f1d8ee144/surfer_mcp-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "505612c727f55757d06562932c3be172fc76fc9fb706f6041f5ef26f443fd9b2",
"md5": "0ba5719cce743193080c0177bcc5a0b8",
"sha256": "bbe5045d54f45a177b9f78f8e3365f125a20ff412f32477129ff3efd948f99f9"
},
"downloads": -1,
"filename": "surfer_mcp-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "0ba5719cce743193080c0177bcc5a0b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13",
"size": 41221,
"upload_time": "2024-12-22T03:03:03",
"upload_time_iso_8601": "2024-12-22T03:03:03.604461Z",
"url": "https://files.pythonhosted.org/packages/50/56/12c727f55757d06562932c3be172fc76fc9fb706f6041f5ef26f443fd9b2/surfer_mcp-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-22 03:03:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "surfer-mcp"
}
