Skip to main content

This is the official MCP server for Surfer

Project description

surfer-mcp MCP server

This is the official MCP server for Surfer

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]

Prerequisites

Windows

  • Microsoft Visual C++ Build Tools is required for building dependencies
  • Install from: Visual C++ Build Tools
    • During installation, ensure "Desktop development with C++" is selected

Install

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Servers Configuration ``` "mcpServers": { "surfer-mcp": { "command": "uv", "args": [ "--directory", "/Users/sahil/Documents/Surfer-Protocol/surfer-mcp", "run", "surfer-mcp" ] } } ```
Published Servers Configuration ``` "mcpServers": { "surfer-mcp": { "command": "uvx", "args": [ "surfer-mcp" ] } } ```

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
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.

You can launch the MCP Inspector via npm with this command:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

surfer_mcp-0.1.2.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

surfer_mcp-0.1.2-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file surfer_mcp-0.1.2.tar.gz.

File metadata

  • Download URL: surfer_mcp-0.1.2.tar.gz
  • Upload date:
  • Size: 41.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.10

File hashes

Hashes for surfer_mcp-0.1.2.tar.gz
Algorithm Hash digest
SHA256 3ae14d5bb848eb7b054f918d724b9c7de4981d15ee80da79ea07170a71094cfb
MD5 8c839d7cf80e41d230309be94fd7b9e9
BLAKE2b-256 4e83658f2f7feb8541b1eee957879579d794524d67373464a149824cf06af168

See more details on using hashes here.

File details

Details for the file surfer_mcp-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: surfer_mcp-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.10

File hashes

Hashes for surfer_mcp-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8913d5153066b1dd126487e2673041afd941e81157288a3595d4ee5262fd1b4f
MD5 d8cb851eac20b7d3fcfd095eae40aef7
BLAKE2b-256 8338d60e34f0ab7fd3f883278e6b38a5c91b8e577de1e6123a486e650210dba9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page