Hello World MCP Server

by jageenshukla
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Manages environment configuration for the MCP server through .env files

  • Handles HTTP endpoints for server-sent events (SSE) and message communication in the MCP server

  • Used for version control and cloning the repository to set up the MCP server

Hello World MCP 서버

Hello World MCP 서버 에 오신 것을 환영합니다! 이 프로젝트는 MCP(Model Context Protocol) SDK를 사용하여 서버를 설정하는 방법을 보여줍니다. 여기에는 SSE(Server-Sent Event) 및 메시지를 처리하기 위한 도구, 프롬프트 및 엔드포인트가 포함되어 있습니다.


특징

  • MCP 통합 : MCP SDK를 사용하여 도구와 프롬프트가 포함된 서버를 만듭니다.
  • Express Framework : SSE 및 메시지 통신을 위한 HTTP 엔드포인트를 처리합니다.
  • 환경 구성 : 쉬운 구성을 위해 .env 파일을 사용합니다.
  • TypeScript 지원 : 더 나은 개발자 경험을 위한 완벽한 유형화된 코드베이스.

필수 조건

시작하기 전에 다음 사항이 설치되어 있는지 확인하세요.

  1. Node.js (v16 이상) - 여기에서 다운로드하세요
  2. npm (Node.js와 함께 제공) 또는 yarn

시작하기

프로젝트를 설정하고 실행하려면 다음 단계를 따르세요.

1. 저장소 복제

아직 하지 않았다면 로컬 컴퓨터에 저장소를 복제하세요.

지엑스피1

2. 종속성 설치

npm 또는 yarn을 사용하여 필요한 종속성을 설치합니다.

npm install

또는

yarn install

3. 환경 변수 구성

이 프로젝트에서는 .env 파일을 사용하여 서버의 포트를 구성합니다. 샘플 .env.example 파일이 제공됩니다.

  1. .env.example 파일을 .env 로 복사합니다.
    cp .env.example .env
  2. .env 파일을 열고 필요한 경우 PORT 변수를 업데이트하세요. 기본값은 4000 입니다.
    PORT=4000

4. 프로젝트 구축

TypeScript 코드를 JavaScript로 컴파일합니다.

npm run build

이렇게 하면 dist 디렉토리에 컴파일된 파일이 생성됩니다.

5. 서버 실행

서버를 프로덕션 모드로 시작합니다.

npm start

또는 라이브 리로딩이 가능한 개발 모드의 경우 다음을 사용하세요.

npm run dev

서버 테스트

1. MCP 검사기 사용

MCP Inspector는 MCP 서버를 테스트하고 검사하는 도구입니다. 도구와 프롬프트가 올바르게 등록되었는지 확인하는 데 사용할 수 있습니다.

다음 명령을 실행하여 서버를 검사하세요.

npx @modelcontextprotocol/inspector ./dist/server.js

이렇게 하면 아래와 같이 서버에 등록된 도구와 프롬프트를 테스트할 수 있는 대화형 인터페이스가 열립니다.


프로젝트 구조

프로젝트 구조 개요는 다음과 같습니다.

hello-world-mcp-server/ ├── src/ │ ├── server.ts # Main server entry point │ ├── modules/ │ │ ├── tools.ts # Registers MCP tools │ │ ├── prompts.ts # Registers MCP prompts │ │ └── transports.ts # Handles SSE and message endpoints ├── .env # Environment variables ├── .env.example # Example environment variables ├── package.json # Project metadata and scripts ├── tsconfig.json # TypeScript configuration └── README.md # Project documentation

문제 해결

일반적인 문제

  1. 포트가 이미 사용 중임 : 포트가 사용 중이라는 오류가 표시되면 .env 파일에서 PORT 변수를 업데이트하세요.
  2. TypeScript 오류 : 모든 종속성을 설치했고 올바른 Node.js 버전을 사용하고 있는지 확인하세요.

디버깅

다음 명령을 사용하여 서버를 디버깅하세요.

npm run dev

이렇게 하면 라이브 리로딩과 자세한 로그가 표시되는 서버가 시작됩니다.


기여하다

기여를 환영합니다! 이슈를 개설하거나 풀 리퀘스트를 제출해 주세요.


특허

이 프로젝트는 ISC 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 라이선스 파일을 참조하세요.

-
security - not tested
F
license - not found
-
quality - not tested

서버에서 전송된 이벤트와 메시지 처리를 위한 도구와 엔드포인트를 제공하는 MCP(Model Context Protocol) SDK를 구현하는 데모 서버입니다.

  1. Features
    1. Prerequisites
      1. Getting Started
        1. 1. Clone the Repository
        2. 2. Install Dependencies
        3. 3. Configure Environment Variables
        4. 4. Build the Project
        5. 5. Run the Server
      2. Testing the Server
        1. 1. Using the MCP Inspector
      3. Project Structure
        1. Troubleshooting
          1. Common Issues
          2. Debugging
        2. Contributing
          1. License
            ID: 80jthm8z6d