MCP server for Byul API
Configuration
View docs{
"mcpServers": {
"byul-ai-mcp-server": {
"command": "npx",
"args": [
"-y",
"@byul/mcp"
],
"env": {
"BYUL_API_KEY": "byul_xxxxxxxxxxxxx"
}
}
}
}You set up this MCP server to securely proxy the Byul REST API through a lightweight, stdio-based interface. It exposes a concise set of MCP tools and a resource that forwards requests to Byul endpoints, returning the original JSON payload along with a short article-count summary. This lets you integrate Byul data into your MCP client workflows with minimal overhead and clear boundaries.
You connect this server to your MCP client, which will launch the server via stdio and communicate using JSON-RPC over stdin/stdout. Use the provided tools to fetch data from Byul and retrieve the exact JSON responses from Byul endpoints, augmented with a readable summary.
In practice, you register the server in your MCP client configuration. You can call the available tools to perform actions like fetching the latest Byul news and retrieving the corresponding data straight from Byul, without needing to manage separate REST calls in your client code.
BYUL_API_KEY=byul_xxxxxxxxxxxxx
npx -y @byul/mcp
````}Prerequisites you need on your machine before starting: Node.js 18 or later and an active Byul API key. After the server is running, your MCP client will communicate with it over a stdio channel using JSON-RPC.
Security: provide the API key exclusively via the BYUL_API_KEY environment variable. Do not embed credentials in code or configuration files.
Platform setup covers multiple environments. The server runs locally and communicates through stdio. If you need to adapt configuration for your client, reference the standard stdio MCP approach and ensure the BYUL_API_KEY is available in your process environment.
Missing API key. If you see an error about a missing BYUL_API_KEY environment variable, set BYUL_API_KEY in your environment before launching the server.
Proxy or firewall issues. Ensure your environment allows npm/npx to reach the registry on first run to fetch @byul/mcp. Configure your proxy settings if necessary.
Windows or WSL specifics. On Windows or WSL, set the environment variable in your shell before running npx, for example: $env:BYUL_API_KEY = "byul_xxxxxxxxxxxxx" followed by npx -y @byul/mcp.
This MCP server is designed for stdio transport only. HTTP/SSE transports are not covered here.
Fetch latest financial news by proxying GET /news with filters: limit, cursor, sinceId, minImportance, q, symbol, startDate, endDate