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

Tools

The server implements one tool:

  • search: Searches for documents in Surfer
    • Takes "query" and "platform" as required string arguments and returns a list of documents that match the query

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.3.tar.gz (41.2 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.3-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for surfer_mcp-0.1.3.tar.gz
Algorithm Hash digest
SHA256 8cbafd797aa25246e563e165f08d91cd7e3690d7eb39f313882766af109a78b3
MD5 acc3fb7a8827cc2fe286eed9917ec44d
BLAKE2b-256 441b4ab970a4d9ee78d4489ae13464ecdfe7dbb51744a1a94d49443ab971ed0d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for surfer_mcp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a3c4da7f6084f14a5bafcace824a360fabfef3af80330da0828991aa9efbc109
MD5 ef56424400d785e6091ab8182a46f7b7
BLAKE2b-256 a5ec1020a18e2ac96421dd4be6ff253ce4ed323f068f58a5c4db9019328c78c6

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