apache / apache/pulsar-client-python

[Example] Add MCP server example for AI agent integration

Aberta
#302 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
Python
Estrelas
75
Forks
53
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

### Motivation

The `examples/` directory shows basic producer/consumer, async, and RPC patterns, but there is no example demonstrating integration with AI agents.

The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) is the emerging standard for connecting AI tools (Cursor, Claude Desktop, Windsurf, etc.) to external data sources. An MCP server example would allow developers to interact with Pulsar topics through natural language, bridging messaging infrastructure and the AI agent ecosystem.

### Proposed Change

Add `examples/mcp_server.py` that exposes three tools via the official MCP Python SDK (`pip install mcp`):

| Tool | Description |
|------|-------------|
| `pulsar_publish` | Publish a message to a topic (supports properties, partition key, delayed delivery) |
| `pulsar_consume` | Consume and auto-acknowledge messages from a subscription |
| `pulsar_peek` | Read messages using a Reader without affecting consumer state |

The example is a standalone script—`mcp` is only required at runtime for this example and is **not** added to the project's `setup.py` dependencies.

### Configuration

Once configured in an MCP-compatible client (e.g. Cursor `~/.cursor/mcp.json`), users can produce and consume Pulsar messages through natural language.

```json
{
"mcpServers": {
"pulsar": {
"command": "python3",
"args": ["examples/mcp_server.py"],
"env": {
"PULSAR_BROKER_URL": "pulsar://localhost:6650"
}
}
}
}
```

I'm happy to submit a PR for this.

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Comece revisando o diretório examples/ existente e as APIs de cliente Python para produtores, consumidores e leitores; em seguida, verifique setup.py para confirmar que a dependência de runtime continua sendo exclusiva dos exemplos. Implemente o ponto de entrada proposto examples/mcp_server.py com as três ferramentas listadas e a configuração de ambiente documentada; considera-se concluído quando o script independente puder expor essas operações sem alterar as dependências do projeto.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
backend, distributed-systems
Tipo de issue
Funcionalidade
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
58/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.