Audius

🚀 Atr Server Documentation

The Atr project is a server built on the MCP (Model Context Protocol), designed to support music, social, and blockchain-related functionalities. It integrates the Audius SDK to provide a comprehensive toolset.

✨ Features

• MCP Compatibility: Complies with the Model Context Protocol standard.
• Audius Integration: Leverages Audius's blockchain music protocol.
• Modular Design: Features independent and scalable modules.
• High Availability: Supports distributed deployment.

🚀 Quick Start

📦 Installation

npm install @audius/audius-sdk @modelcontextprotocol/mcp-server

Initial Configuration

Create a config.ts file:

export const config = {
  port: 3000,
  audiusNodeUrl: 'https://nodes.audius.org',
  ethProviderUrl: 'https://eth-mainnet.g.alchemy.com/v2/your-api-key'
}

Start the Server

npm run dev

📚 Documentation

The config.ts file contains the following configuration items:

• port: The port the service listens on, default is 3000.
• audiusNodeUrl: The URL of the Audius network node.
• ethProviderUrl: The address of the Ethereum RPC provider.

🔧 Technical Details

Core Utility Classes

AtrSdkClient

Encapsulates common operations of the Audius SDK and provides a simple interface:

class AtrSdkClient {
  private audiusSdk: AudiusSDK

  constructor(config: Config) {
    this.audiusSdk = new AudiusSDK({
      nodeUrl: config.audiusNodeUrl,
      ethProvider: config.ethProviderUrl
    })
  }

  async getTrack(trackId: string): Promise<Track> {
    return await this.audiusSdk.getTrack(trackId)
  }
}

McpServer

Implements the server-side logic of the MCP protocol:

class McpServer {
  private port: number

  constructor(private config: Config) {
    this.port = config.port
  }

  async start(): Promise<void> {
    const server = new Server()
    // Register all tools and resources
    registerMcpTools(server, this.config)
    await server.listen(this.port)
    console.log(`Server running on port ${this.port}`)
  }
}

💻 Usage Examples

Core Features

• Music Playback
  • Stream audio.
  • Query music work information.
• User Social
  • Manage user follows and followers.
  • Statistic social interaction data.
• Blockchain Integration
  • Manage digital copyrights.
  • Process cryptocurrency transactions.

Extended Modules

• Content Moderation
  • Automatically detect content.
  • Block违规 content.
• Data Analysis
  • Track user behavior.
  • Implement intelligent recommendation systems.
• Payment Gateway
  • Support multiple payment methods.
  • Handle financial reconciliation.

📁 Development Structure

Directory Structure

atrium/
├── src/
│   ├── config.ts              # Project configuration file
│   ├── server.ts              # Server main program
│   ├── tools/                 # Tool module collection
│   │   ├── atr-sdk-client.ts    # Atr SDK client implementation
│   │   └── mcp-server.ts       # MCP protocol server implementation
│   └── resources/             # Resource management module
│       ├── music-resource.ts  # Music resource management
│       └── user-resource.ts   # User resource management

Core Interfaces

• Track

  interface Track {
    id: string
    title: string
    artist: string
    duration: number
    audioUrl?: string | null
  }
  

• User

  interface User {
    id: string
    username: string
    followersCount: number
    followingCount: number
  }
  

Example Workflows

Music Discovery

1. Get music work information:

const trackId = '123'
const track = await atrSdkClient.getTrack(trackId)

2. Stream audio:

const audioStream = await getAudioStream(trackId)
audioStream.pipeTo(audioElement)

Content Creation

1. Upload a music work:

await uploadMusic({
  title: 'New Track',
  artist: 'Your Name',
  duration: 240,
  audioFile: file
})

2. Post an activity:

await postActivity('Check out my new track!', {
  type: 'music',
  trackId: '123'
})

Social Interaction

1. Follow a user:

await followUser('new_artist')

2. Get user information:

const user = await getUserInfo('new_artist')

Digital Copyright Management

1. Create an NFT:

await createNft({
  name: 'Unique Track',
  description: 'Limited edition music NFT',
  trackId: '123'
})

2. Transfer an NFT:

await transferNft('123', 'buyer_address')

🧪 Testing Guide

Environment Setup

• Install Node.js and npm.
• Configure an Ethereum wallet and API key.
• Start a local test network or use a public node.

Debugging with MCP Inspector

1. Start the Inspector:

npm install -g @modelcontextprotocol/mcp-inspector
mcp-inspect --host localhost:3000

2. Operation steps:

const inspect = require('@modelcontextprotocol/mcp-inspector')

inspect('localhost:3000', {
  // Add inspection logic
})

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.