NE

niklaserik/effect-mcp

Developer tools

Эта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал

45 stars 4 forks Качество 59 Тренд 12MIT

Сервер mcp для получения документации Effect-ts

Обзор

Сервер Model Context Protocol (MCP), предназначенный для извлечения самой актуальной документации из экосистемы Effect. Этот сервер MCP обеспечивает доступ к документации по эффекту в режиме реального времени для помощников и инструментов ИИ. Это позволяет расширениям VS Code и другим клиентам MCP получать точную и актуальную документацию пакета Effect, чтобы помочь разработчикам с вопросами о: - Пакет основных эффектов - Пакеты экосистем (@effect/platform, @effect/ai и т.д.) - Пакеты стабильных и нестабильных эффектов Сервер интеллектуально обнаруживает импортные пакеты Effect в вашем коде и извлекает наиболее релевантную документацию для ответа на ваши запросы.

Обзор (машинный перевод)

Сервер Model Context Protocol (MCP), предназначенный для извлечения самой актуальной документации из экосистемы Effect.

##Цель

Этот сервер MCP обеспечивает доступ к документации по эффекту в режиме реального времени для помощников и инструментов ИИ. Это позволяет расширениям VS Code и другим клиентам MCP получать точную и актуальную документацию пакета Effect, чтобы помочь разработчикам с вопросами о:

  • основной пакет effect Экосистемные пакеты @effect/platform, @effect/ai и т.д. Стабильные и нестабильные пакеты эффектов

Сервер интеллектуально обнаруживает импортные пакеты Effect в вашем коде и извлекает наиболее релевантную документацию для ответа на ваши запросы.

Особенности

Доступ к документации в режиме реального времени для экосистемы Effect Поддержка как стабильных, так и экспериментальных пакетов

  • Обнаружение пакетов с учетом контекста на основе импорта Бесшовная интеграция с VS Code и другими MCP-совместимыми клиентами Помогает ответить на вопросы об использовании API для разработчиков Effect

Что показывает этот сервер

Ресурсы (предпочтительно) Динамический шаблон: effect-docs://{libId}

  • Поддержку составляют {libId} и список ресурсов

Эта страница переведена автоматически. Технические детали смотрите в оригинале.

README

@niklaserik/effect-mcp

A Model Context Protocol (MCP) server dedicated to fetching the most current documentation from the Effect ecosystem.

Purpose

This MCP server provides real-time access to Effect documentation for AI assistants and tools. It enables VS Code extensions and other MCP clients to retrieve accurate and up-to-date Effect package documentation to assist developers with questions about:

  • The core effect package
  • Ecosystem packages (@effect/platform, @effect/ai, etc.)
  • Both stable and unstable Effect packages

The server intelligently detects imported Effect packages in your code and fetches the most relevant documentation to answer your queries.

Features

  • Real-time documentation access for Effect ecosystem
  • Support for both stable and experimental packages
  • Context-aware package detection based on imports
  • Seamless integration with VS Code and other MCP-compatible clients
  • Helps answer API usage questions for Effect developers

What this server exposes

  • Resources (preferred)
    • Dynamic template: effect-docs://{libId}
    • Completions on {libId} and resource listing are supported
    • Static aliases for discovery: effect-docs://effect, effect-docs://@effect-platform, etc.
    • Supported libraries (as of now):
      • effect
      • @effect/platform
      • @effect/sql
      • @effect/vitest
      • @effect/ai
      • @effect/cli
      • @effect/cluster
      • @effect/rpc
      • @effect/typeclass
  • Tools (for compatibility)
    • effect-documentation: fetch docs for selected libraries and return concatenated markdown
    • effect-doc-links: return plain URIs to the resources above so clients can follow them

Caching & Retry

  • In-memory TTL cache (~10 minutes) to avoid refetching unchanged docs.
  • Lightweight retry with small backoff on transient fetch errors.

Installation

pnpm add @niklaserik/effect-mcp

Usage

For usage in VS Code or other MCP clients, refer to the client’s documentation for adding custom MCP servers.

Quick test locally:

pnpm install
pnpm build
node dist/index.js # stdio transport

Then connect with an MCP client (e.g., MCP Inspector) over stdio and try:

  • List resources and read effect-docs://effect
  • Call tool effect-doc-links with { "libraries": ["effect", "@effect/platform"] }

Initialization instructions

  • The server publishes short usage instructions via MCP initialize for clients that display them.

Development

# Install dependencies
pnpm install

# Build the project
pnpm build

# Run in development mode with auto-reload
pnpm dev

Notes:

  • Built with @modelcontextprotocol/sdk@^1.17.4 using the modern registerResource/registerTool APIs.
  • Transport: stdio by default; can be adapted to Streamable HTTP if needed.

License

MIT

Открыть полный README на GitHub

Установка

This server does not publish a one-line install command.

Open the repository installation guide Новичок в MCP? Начните с руководства на mcpskill.org →