Sbb MCP Server

🚀 MCP TypeScript Project Guide

MCP TypeScript is a framework for building efficient server-side applications. It supports various functional modules, including tools, resources, and prompt templates. The following content will detail how to use this framework to implement these functions, and provide relevant configurations and best practices.

🚀 Quick Start

Core Components

1. Tools
   • Used to perform specific tasks, such as data processing or API calls.
2. Resources
   • Provide resource interfaces accessible via URIs.
3. Prompt Templates
   • Define how to convert user input into conversation messages.

Example Implementations

Tool Example: Echo Tool

server.tool("echo", { message: z.string() }, async ({ message }) => ({
  content: [{ type: "text", text: `Tool echo: ${message}` }],
}));

Resource Example: Echo Resource

server.resource(
  "echo",
  new ResourceTemplate("echo://{message}", { list: undefined }),
  async (uri, { message }) => ({
    contents: [
      {
        uri: uri.href,
        text: `Resource echo: ${message}`,
      },
    ],
  })
);

Prompt Template Example: Echo Prompt

server.prompt("echo", { message: z.string() }, ({ message }) => ({
  messages: [
    {
      role: "user",
      content: {
        type: "text",
        text: `Please process this message: ${message}`,
      },
    },
  ],
}));

📁 Project Structure

• src/index.ts: The main server implementation file.
• src/low - level - index.ts: An alternative implementation using low - level APIs.
• dist/: The compilation output directory.

⚙️ Configuration and Deployment

Environment Variable Configuration

1. Using Docker Compose

   # docker-compose.yaml
   services:
     mmcp-server:
       environment:
         - API_KEY=${API_KEY}
         - DATABASE_URL=${DATABASE_URL}
   

2. Accessing in Code

   const apiKey = process.env.API_KEY;
   const dbUrl = process.env.DATABASE_URL;
   

3. Local Development
   • Create a .env file:

     API_KEY=sk-123
     

   • Add .env to .gitignore.
4. Production Deployment
   • Set environment variables on the deployment platform.
   • Avoid committing sensitive information to version control.

Security Precautions

• Use different sets of environment variables for development and production.
• Ensure that sensitive information is not exposed to clients.

💡 Best Practices

1. Error Handling
   • Implement a comprehensive error handling mechanism.
   • Provide meaningful error messages.
2. Type Safety
   • Use TypeScript to define environment variable types.
   • Adopt zod for runtime verification.
3. Logging
   • Use server.server.sendLoggingMessage to send debugging information:

   server.server.sendLoggingMessage({
     level: "info",
     data: "Starting server...",
   });
   

🚢 Project Deployment

Docker Deployment Example

docker build -t mcp-typescript .
docker run -p 3000:3000 --env API_KEY=your_key mcp-typescript

Listening Endpoint Testing

Use curl or Postman to test service endpoints:

curl http://localhost:3000/echo?message=test

📄 License

• License: MIT License
• Maintainer: MCP Development Team

🤝 Contribution Guide

Contributions from the community are welcome! Please refer to CONTRIBUTING.md.

🐞 Issue Feedback

If you encounter any issues, please submit them to GitHub Issues.

The above is a detailed guide to the MCP TypeScript framework, covering the complete process from configuration to deployment. We hope it will be helpful for you to build efficient server - side applications!