ModelContextProtocol 项目使用教程

ModelContextProtocol 项目使用教程

modelcontextprotocol A Model Context Protocol Server connector for Perplexity API, to enable web search without leaving the MCP ecosystem. 项目地址: https://gitcode.com/gh_mirrors/mo/modelcontextprotocol

1. 项目目录结构及介绍

ModelContextProtocol 项目是一个用于集成 Sonar API 的 MCP（Model Context Protocol）服务器连接器，其目录结构如下：

modelcontextprotocol/
├── Dockerfile
├── LICENSE
├── README.md
├── .gitignore
├── perplexity-ask/
│   ├── .gitignore
│   ├── Dockerfile
│   ├── package.json
│   ├── tsconfig.json
│   ├── .vscode/
│   │   └── settings.json
│   ├── src/
│   │   ├── index.ts
│   │   ├── askPerplexity.ts
│   │   └── utils.ts
│   └── test/
│       └── index.test.ts

• Dockerfile: 用于构建项目的 Docker 镜像。
• LICENSE: 项目的 MIT 许可证文件。
• README.md: 项目的说明文档。
• .gitignore: 指定 Git 忽略的文件和目录。
• perplexity-ask/: 包含项目的主要代码和配置文件。
  • Dockerfile: 用于构建子项目的 Docker 镜像。
  • package.json: 定义了项目的依赖和脚本。
  • tsconfig.json: TypeScript 配置文件。
  • .vscode/settings.json: Visual Studio Code 的项目配置。
  • src/: 源代码目录。
  • test/: 测试代码目录。

2. 项目的启动文件介绍

项目的启动文件是位于 perplexity-ask/src/index.ts 的 TypeScript 文件。它包含了启动 MCP 服务器的逻辑，以及与 Sonar API 进行通信的代码。

// index.ts 的简化示例内容
import { PerplexityAsk } from './askPerplexity';

const server = new PerplexityAsk();
server.start();

在实际使用中，你需要首先通过 npm 安装依赖，然后使用以下命令启动服务器：

cd modelcontextprotocol/perplexity-ask
npm install
npm start

3. 项目的配置文件介绍

项目的配置主要通过 perplexity-ask/src/askPerplexity.ts 文件中的代码来实现。在这个文件中，你可以设置 Sonar API 的密钥，以及其他相关参数。

配置文件的一个示例片段如下：

// askPerplexity.ts 的简化示例内容
class PerplexityAsk {
  private apiKey: string;

  constructor(apiKey: string) {
    this.apiKey = apiKey;
  }

  // 其他方法和逻辑...
}

// 在环境变量中设置 API 密钥
const apiKey = process.env.PERPLEXITY_API_KEY;
const server = new PerplexityAsk(apiKey);

你需要在环境变量中设置 PERPLEXITY_API_KEY，以便服务器能够使用 Sonar API。可以通过以下方式设置：

export PERPLEXITY_API_KEY=你的API密钥

确保你已经从 Sonar API 官方网站获取了 API 密钥，并正确设置了环境变量。

modelcontextprotocol A Model Context Protocol Server connector for Perplexity API, to enable web search without leaving the MCP ecosystem. 项目地址: https://gitcode.com/gh_mirrors/mo/modelcontextprotocol