Skip to main content

​
What does it provide?

@byul/mcp exposes Byul’s REST API through MCP tools and resources over stdio.
  • Tool: news_fetch – proxies GET /news (filters and pagination)
  • Resource: byul://news{?limit,cursor,sinceId,minImportance,q,symbol,startDate,endDate}
  • Response format: summary string + original JSON payload

​
Requirements

  • Node.js 18+
  • BYUL_API_KEY environment variable (e.g., byul_api_key)

​
Architecture

1

Register the MCP server

Register @byul/mcp in your MCP-compatible client.
2

Communicate via stdio

The client launches the server via stdio and uses JSON-RPC over stdin/stdout.
3

Proxy to Byul REST API

Tool/resource calls are forwarded to Byul endpoints and returned as-is with a summary.