xmcp: uma estrutura TypeScript para criar e distribuir aplicativos MCP

O xmcp é uma estrutura de desenvolvimento baseada em TypeScript projetada para criar e distribuir aplicativos MCP (Model Context Protocol). O xmcp simplifica o processo de desenvolvimento, permitindo que os desenvolvedores criem rapidamente ferramentas eficientes e as implementem no ecossistema MCP. O xmcp simplifica o processo de desenvolvimento, permitindo que os desenvolvedores criem rapidamente ferramentas eficientes e as implementem no ecossistema MCP. O xmcp se concentra na experiência do desenvolvedor, fornecendo roteamento do sistema de arquivos, hot reloading e suporte flexível a middleware. Tanto os desenvolvedores iniciantes quanto os profissionais podem começar rapidamente com suas ferramentas intuitivas de configuração e automação. Ele oferece suporte a plataformas como a Vercel, é fácil de implantar e altamente compatível. O site oficial fornece documentação detalhada para os desenvolvedores que desejam explorar o desenvolvimento do MCP.

Lista de funções

• Ferramenta de registro automático: detoolsO diretório descobre e registra automaticamente os arquivos de ferramentas.
• Roteamento do sistema de arquivos: simplifique o desenvolvimento com o gerenciamento de roteamento baseado na estrutura de arquivos.
• Hot reloading: feedback instantâneo após alterações no código para aumentar a eficiência do desenvolvimento.
• Suporte a middleware: fornece autenticação e middleware personalizado para aprimorar a extensão da funcionalidade.
• Configuração flexível: por meio dexmcp.config.tsPersonalize as configurações do servidor MCP.
• Implementação entre plataformas: suporta plataformas como a Vercel, fácil de implementar e altamente compatível.
• Adaptadores Next.js e Express: integração perfeita com projetos existentes.
• Suporte à documentação oficial: fornece diretrizes detalhadas de desenvolvimento e implantação.

Usando a Ajuda

Processo de instalação

O processo de instalação do xmcp é simples e adequado para Windows, macOS e Linux. Veja a seguir as etapas detalhadas:

1. Instalação do Node.js
   Certifique-se de que o Node.js esteja instalado em seu sistema (versão recomendada 18 ou superior). Visite o site oficial do Node.js para fazer o download e instalá-lo. Após a instalação, execute o seguinte comando para verificar a versão:

   node -v
   npm -v
   

2. Criar um projeto
   Selecione um diretório no terminal e execute o seguinte comando para inicializar o projeto xmcp:

   npx create-xmcp@latest my-project
   

   gera um arquivo chamadomy-projectda pasta do projeto que contém a seguinte estrutura:

   my-project/
   ├── src/
   │   ├── middleware.ts    # 中间件处理HTTP请求/响应
   │   └── tools/           # 工具文件自动注册
   │       ├── greet.ts
   │       ├── search.ts
   ├── dist/                # 编译输出目录
   ├── package.json
   ├── tsconfig.json
   └── xmcp.config.ts       # xmcp配置文件
   

3. Instalação de dependências
   Vá para o diretório do projeto e instale as dependências:

   cd my-project
   npm install
   

4. Iniciando o servidor de desenvolvimento
   Execute o seguinte comando para iniciar o servidor de desenvolvimento local:

   npm run dev
   

   Por padrão, o servidor é executado nohttp://localhost:3000. Abra o acesso ao navegador para visualizar o aplicativo. O recurso Hot Reload reflete as alterações de código em tempo real.

Funções principais

1. criação de ferramentas

xmcp aprovadotoolsFerramenta de registro automático de diretório. O desenvolvedor só precisa adicionar osrc/tools/Crie arquivos TypeScript em. Por exemplo, crie uma ferramenta de saudaçãogreet.ts::

export default {
name: "greet",
description: "Returns a greeting message",
async handler(input: string) {
return `Hello, ${input}!`;
},
};

Após salvar, a ferramenta será registrada automaticamente sem a necessidade de configurá-la manualmente. Acesso ahttp://localhost:3000/mcp?name=greetPode ser resgatado.

2. middleware de configuração

O middleware é usado para processar solicitações e respostas HTTP, como autenticação ou registro. Na seçãosrc/middleware.tsDefina o middleware na seção

import { Middleware } from "xmcp";
export default function authMiddleware(): Middleware {
return async (req, res, next) => {
const authHeader = req.headers.authorization;
if (!authHeader) {
res.status(401).json({ error: "Unauthorized" });
return;
}
await next();
};
}

O middleware será executado antes que a solicitação seja processada e é adequado para adicionar lógica personalizada.

3. configuração personalizada

aprovar (um projeto de lei ou inspeção etc.)xmcp.config.tsAjustar as configurações do servidor, como portas ou catálogos de ferramentas:

import { defineConfig } from "xmcp";
export default defineConfig({
port: 3001,
toolsDir: "src/tools",
middleware: ["authMiddleware"],
});

Modifique e reinicie o servidor para aplicar a configuração.

4. implantação na Vercel

O xmcp é compatível com a implantação em um clique do Vercel. Certifique-se de que o projeto seja enviado para o repositório do GitHub:

1. Faça login no site oficial da Vercel e conecte-se ao repositório do GitHub.
2. Selecione o projeto xmcp e o Vercel detectará automaticamente a configuração.
3. Clique no botão "Deploy" (Implantar) e aguarde a conclusão da implantação.
   Após a implantação bem-sucedida, a Vercel fornecerá um URL público, comohttps://my-project.vercel.app.

Operação da função em destaque

recarga térmica

No modo de desenvolvimento, modifique otoolsOs arquivos no diretório acionam um recarregamento automático. Não há necessidade de reiniciar manualmente o servidor, o que o torna adequado para iteração rápida. Por exemplo, a edição do diretóriogreet.tsna mensagem de retorno, salve-a e veja imediatamente a atualização em seu navegador.

Roteamento do sistema de arquivos

xmcp de acordo comtoolsA estrutura de diretórios gera rotas automaticamente. Por exemplo.src/tools/search.tsgerará/mcp?name=searchde roteamento. Os desenvolvedores não precisam configurar manualmente as tabelas de roteamento, o que simplifica o gerenciamento.

Integração com o Next.js

Se você já tiver um projeto Next.js, poderá integrar o xmcp por meio de um adaptador. Instale o xmcp no projeto Next.js:

npm install xmcp

depois dissopages/api/mcp.tsAdicionar em:

import { createMcpHandler } from "xmcp/next";
export default createMcpHandler({
toolsDir: "src/tools",
});

Reinicie o aplicativo Next.js e a função xmcp poderá ser usada no/api/mcpcaminho a ser usado.

cenário do aplicativo

1. Prototipagem rápida
   Os desenvolvedores podem aproveitar o hot reloading do xmcp e o roteamento do sistema de arquivos para criar rapidamente protótipos de ferramentas MCP. Por exemplo, para desenvolver uma ferramenta de pesquisa, basta adicionar o comandotoolsAdições ao catálogosearch.tsA função pode ser testada em poucos minutos.
2. Desenvolvimento de serviços de API
   O xmcp é adequado para o desenvolvimento de serviços de API baseados em MCP. A autenticação e o registro por meio de middleware, combinados com a implantação do Vercel, são adequados para aplicativos móveis ou da Web para fornecer suporte de back-end.
3. Integração de projetos existentes
   Para projetos Next.js ou Express existentes, os adaptadores do xmcp se integram perfeitamente. Os desenvolvedores podem adicionar a funcionalidade do MCP sem refatorar o código existente.
4. Educação e aprendizado
   Os desenvolvedores iniciantes podem aprender a desenvolver TypeScript e MCP com o xmcp. Sua configuração e documentação intuitivas reduzem o limite de aprendizado para os iniciantes praticarem.

QA

1. Quais linguagens de programação são compatíveis com o xmcp?
   O xmcp é desenvolvido principalmente com TypeScript, mas o aplicativo MCP gerado pode ser chamado via HTTP, compatível com qualquer linguagem que ofereça suporte a HTTP.
2. Como faço para depurar uma ferramenta?
   No modo de desenvolvimento, executenpm run devVisualize o registro do console do terminal. Os erros de execução da ferramenta são exibidos em detalhes, facilitando a localização do problema.
3. Ele oferece suporte à autenticação de vários usuários?
   Sim, a autenticação de vários usuários pode ser obtida por meio de middleware. O desenvolvedor precisa adicionar a opçãomiddleware.tsImplementar a lógica de autenticação, por exemplo, verificando o JWT.
4. É viável implementar em uma plataforma que não seja da Vercel?
   viável. O xmcp oferece suporte à implantação em várias plataformas, bastando adicionar odistO diretório é carregado em uma plataforma compatível com o Node.js, como o AWS ou o Heroku.