Skip to main content

​
Overview

@byul/mcp is a stdio-based MCP server that proxies the Byul REST API. It exposes a tool and a resource that forward requests to Byul endpoints and return the original JSON payload along with a brief summary string.
Requirements: Node.js 18+ and the BYUL_API_KEY environment variable

​
Install and Run

BYUL_API_KEY=byul_api_key npx -y @byul/mcp
Once launched, your MCP-compatible client will communicate with the server via stdio.

​
What’s Included

  • Tool: news_fetch – proxies GET /news with filtering and pagination
  • Resource: byul://news{?limit,cursor,sinceId,minImportance,q,symbol,startDate,endDate}
  • Response: summary string (e.g., “Returned N articles”) + original Byul API JSON

​
Next Steps

Introduction

Concepts and architecture

Setup

Client/editor integration

news_fetch

Tool specification

byul://news

Resource specification