{"_id":"@byul/mcp","_rev":"5-b67edbe5a0a4621fdccf2b74c2dec249","name":"@byul/mcp","dist-tags":{"latest":"0.1.4"},"versions":{"0.1.0":{"name":"@byul/mcp","version":"0.1.0","keywords":["mcp","server","ai","news","byul","sdk"],"author":{"url":"https://byul.ai","name":"Byul"},"license":"MIT","_id":"@byul/mcp@0.1.0","maintainers":[{"name":"lovelacedud","email":"lovelacedud@gmail.com"}],"homepage":"https://byul.ai","bugs":{"url":"https://github.com/byul-ai/mcp-server/issues"},"bin":{"byul-mcp":"dist/cli.js"},"dist":{"shasum":"8c32c075de08b41b70b4819edca5fadbbd2fb69d","tarball":"https://registry.npmjs.org/@byul/mcp/-/mcp-0.1.0.tgz","fileCount":8,"integrity":"sha512-8NnUXUYtPfGuVc9yWDDU//Mmj3P+9H4egg5d4htOpYEx/Rjd76J765+FsUuhV0z1NBwpsNc3kjyzHZIBKHjDSQ==","signatures":[{"sig":"MEQCIHGNKMbGj3vWQTY1v8vHCKzSI62voEyV66B1SmNJZ0QkAiAVsW2uoDbi9uVRVBL7Kaoxzu7mbbNJI1+7X8yE4xb+Lg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":15410},"main":"./dist/index.js","type":"module","_from":"file:byul-mcp-0.1.0.tgz","types":"./dist/index.d.ts","engines":{"node":">=18.17.0"},"exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"./package.json":"./package.json"},"scripts":{"dev":"tsx src/cli.ts","build":"tsc -p tsconfig.json && node scripts/postbuild.js","start":"node ./dist/cli.js","typecheck":"tsc --noEmit"},"_npmUser":{"name":"lovelacedud","email":"lovelacedud@gmail.com"},"_resolved":"/private/var/folders/zr/bj_14x6s3kz88g37h_8d_7_h0000gn/T/ba801de95b00faed2504cba4c3a0694f/byul-mcp-0.1.0.tgz","_integrity":"sha512-8NnUXUYtPfGuVc9yWDDU//Mmj3P+9H4egg5d4htOpYEx/Rjd76J765+FsUuhV0z1NBwpsNc3kjyzHZIBKHjDSQ==","repository":{"url":"git+https://github.com/byul-ai/mcp-server.git","type":"git"},"_npmVersion":"11.5.1","description":"Byul MCP server (stdio) proxying Byul REST API","directories":{},"sideEffects":false,"_nodeVersion":"24.5.0","dependencies":{"zod":"^3.23.8","@modelcontextprotocol/sdk":"^1.2.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.16.2","typescript":"^5.5.4","@types/node":"^22.7.4"},"_npmOperationalInternal":{"tmp":"tmp/mcp_0.1.0_1755339180519_0.3487551582263968","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@byul/mcp","version":"0.1.1","keywords":["mcp","server","ai","news","byul","sdk"],"author":{"url":"https://byul.ai","name":"Byul"},"license":"MIT","_id":"@byul/mcp@0.1.1","maintainers":[{"name":"lovelacedud","email":"lovelacedud@gmail.com"}],"homepage":"https://byul.ai","bugs":{"url":"https://github.com/byul-ai/mcp-server/issues"},"bin":{"byul-mcp":"dist/cli.js"},"dist":{"shasum":"d3c263e8caaf70b577ab72ec836eae3cc0fb3940","tarball":"https://registry.npmjs.org/@byul/mcp/-/mcp-0.1.1.tgz","fileCount":8,"integrity":"sha512-w+Ak2lCEUBXW8+CY/joT/DfwAZYxnLB0+b5Tyi6AU1ezgwDZDk9ba2R/yJxz9oqI+trNa8lQ5zVorH7bdwZ/sw==","signatures":[{"sig":"MEQCIFIlQhhQ0xP+ed5DjqwkceD7ec4aRMbo0oyowPq81SyFAiBpieuvRDhZoQ2xL8G7K7Ex3hmNFaaz/mhrutGj9cNBoA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":15593},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18.17.0"},"exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"./package.json":"./package.json"},"gitHead":"cc03ee851d2b01d52c029617a6822223f50d1a4b","scripts":{"dev":"tsx src/cli.ts","build":"tsc -p tsconfig.json && node scripts/postbuild.js","start":"node ./dist/cli.js","prepare":"pnpm build","typecheck":"tsc --noEmit"},"_npmUser":{"name":"lovelacedud","email":"lovelacedud@gmail.com"},"repository":{"url":"git+https://github.com/byul-ai/mcp-server.git","type":"git"},"_npmVersion":"11.5.1","description":"Byul MCP server (stdio) proxying Byul REST API","directories":{},"sideEffects":false,"_nodeVersion":"24.5.0","dependencies":{"zod":"^3.23.8","@modelcontextprotocol/sdk":"^1.2.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"packageManager":"pnpm@10","devDependencies":{"tsx":"^4.16.2","typescript":"^5.5.4","@types/node":"^22.7.4"},"_npmOperationalInternal":{"tmp":"tmp/mcp_0.1.1_1755358525207_0.43768184233374074","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@byul/mcp","version":"0.1.2","keywords":["mcp","server","ai","news","byul","sdk"],"author":{"url":"https://byul.ai","name":"Byul"},"license":"MIT","_id":"@byul/mcp@0.1.2","maintainers":[{"name":"lovelacedud","email":"lovelacedud@gmail.com"}],"homepage":"https://byul.ai","bugs":{"url":"https://github.com/byul-ai/mcp-server/issues"},"bin":{"byul-mcp":"dist/cli.js"},"dist":{"shasum":"3cfe1fd50856ac7af06148da2275ba22a2548a61","tarball":"https://registry.npmjs.org/@byul/mcp/-/mcp-0.1.2.tgz","fileCount":8,"integrity":"sha512-kyn5EsIKo/QXDr0Ph0STSxzwllDFB4j/ck6vTCC3ExQud8wr/I3N53CxtosQiMuAxEQS6bv07pho7cstrf+hEg==","signatures":[{"sig":"MEQCIGq6ZaO0x2TaqT9Cmr8gM4VhrxW0CoEV+I9IGNKeMxWsAiBcWlu981TT9CeLTZe9JE3MbgDQW2nFZxuxkq0UrYzhrQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":19463},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18.17.0"},"exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"./package.json":"./package.json"},"gitHead":"51c21969584b1fa08cf42ad39c000a2337940163","scripts":{"dev":"tsx src/cli.ts","build":"tsc -p tsconfig.json && node scripts/postbuild.js","start":"node ./dist/cli.js","prepare":"pnpm build","typecheck":"tsc --noEmit"},"_npmUser":{"name":"lovelacedud","email":"lovelacedud@gmail.com"},"repository":{"url":"git+https://github.com/byul-ai/mcp-server.git","type":"git"},"_npmVersion":"11.5.1","description":"Byul MCP server (stdio) proxying Byul REST API","directories":{},"sideEffects":false,"_nodeVersion":"24.5.0","dependencies":{"zod":"^3.23.8","@modelcontextprotocol/sdk":"^1.2.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"packageManager":"pnpm@10","devDependencies":{"tsx":"^4.16.2","typescript":"^5.5.4","@types/node":"^22.7.4"},"_npmOperationalInternal":{"tmp":"tmp/mcp_0.1.2_1755359742694_0.31098860382368376","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@byul/mcp","version":"0.1.3","keywords":["mcp","server","ai","news","byul","sdk"],"author":{"url":"https://byul.ai","name":"Byul"},"license":"MIT","_id":"@byul/mcp@0.1.3","maintainers":[{"name":"lovelacedud","email":"lovelacedud@gmail.com"}],"homepage":"https://byul.ai","bugs":{"url":"https://github.com/byul-ai/mcp-server/issues"},"bin":{"byul-mcp":"dist/cli.js"},"dist":{"shasum":"61393909d48da1843f86236a20c55c6c4f612f7a","tarball":"https://registry.npmjs.org/@byul/mcp/-/mcp-0.1.3.tgz","fileCount":8,"integrity":"sha512-Go3dUuAKyRQI4fRJYf/gs1wSicdPonrwdAehwIKUb8+phTBxNqigsnOpVUVtEULeKCJYCnXLFfIp2Wzubk9Xjw==","signatures":[{"sig":"MEUCICTVyhEiib8uuLnWcgjiBuel+7tkTTPAD76JB372xXJKAiEA5jW7wtU3zfequCyX0xhsO4HPuwGB/eGdCVxyggRAaTY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":14980},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18.17.0"},"exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"./package.json":"./package.json"},"gitHead":"d24f9dba56674f462f7a815020663894adf85256","scripts":{"dev":"tsx src/cli.ts","build":"tsc -p tsconfig.json && node scripts/postbuild.js","start":"node ./dist/cli.js","prepare":"pnpm build","typecheck":"tsc --noEmit"},"_npmUser":{"name":"lovelacedud","email":"lovelacedud@gmail.com"},"repository":{"url":"git+https://github.com/byul-ai/mcp-server.git","type":"git"},"_npmVersion":"11.5.1","description":"Byul MCP server (stdio) proxying Byul REST API","directories":{},"sideEffects":false,"_nodeVersion":"24.5.0","dependencies":{"zod":"^3.23.8","@modelcontextprotocol/sdk":"^1.2.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"packageManager":"pnpm@10","devDependencies":{"tsx":"^4.16.2","typescript":"^5.5.4","@types/node":"^22.7.4"},"_npmOperationalInternal":{"tmp":"tmp/mcp_0.1.3_1755360670813_0.19653902631155917","host":"s3://npm-registry-packages-npm-production"}},"0.1.4":{"name":"@byul/mcp","version":"0.1.4","description":"Byul MCP server (stdio) proxying Byul REST API","type":"module","bin":{"byul-mcp":"dist/cli.js"},"main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"./package.json":"./package.json"},"scripts":{"build":"tsc -p tsconfig.json && node scripts/postbuild.js","dev":"tsx src/cli.ts","start":"node ./dist/cli.js","typecheck":"tsc --noEmit","prepare":"pnpm build"},"engines":{"node":">=18.17.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"license":"MIT","author":{"name":"Byul","url":"https://byul.ai"},"repository":{"type":"git","url":"git+https://github.com/byul-ai/mcp-server.git"},"bugs":{"url":"https://github.com/byul-ai/mcp-server/issues"},"homepage":"https://byul.ai","keywords":["mcp","server","ai","news","byul","sdk"],"sideEffects":false,"packageManager":"pnpm@10","dependencies":{"@modelcontextprotocol/sdk":"^1.2.0","zod":"^3.23.8"},"devDependencies":{"@types/node":"^22.7.4","tsx":"^4.16.2","typescript":"^5.5.4"},"_id":"@byul/mcp@0.1.4","gitHead":"79ef682e6bf696135a20afff9d8e19035ea08672","_nodeVersion":"24.5.0","_npmVersion":"11.5.1","dist":{"integrity":"sha512-eQBoOApslfEWm+T1mHEt4hgSbZcAUxclrsr2DmZHfHUtbUr1BB7bftWT8tRs1OCDAzYEM9zp1SFB/iXzTSc9Ig==","shasum":"9ee2e29b661b985438ae737d20608345fa70f6e0","tarball":"https://registry.npmjs.org/@byul/mcp/-/mcp-0.1.4.tgz","fileCount":8,"unpackedSize":15627,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCigNt90JHjqV+I68KkR1krzon3IAnZYh9tM3yAQ0QA8AIgRRq+IJSWAG+/y1HB6XHe//M0FvyZL/SRbdt1u1aHXyM="}]},"_npmUser":{"name":"lovelacedud","email":"lovelacedud@gmail.com"},"directories":{},"maintainers":[{"name":"lovelacedud","email":"lovelacedud@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp_0.1.4_1755607796924_0.9446183500486012"},"_hasShrinkwrap":false}},"time":{"created":"2025-08-16T10:13:00.465Z","modified":"2025-08-19T12:49:57.327Z","0.1.0":"2025-08-16T10:13:00.704Z","0.1.1":"2025-08-16T15:35:25.428Z","0.1.2":"2025-08-16T15:55:42.897Z","0.1.3":"2025-08-16T16:11:10.996Z","0.1.4":"2025-08-19T12:49:57.114Z"},"bugs":{"url":"https://github.com/byul-ai/mcp-server/issues"},"author":{"name":"Byul","url":"https://byul.ai"},"license":"MIT","homepage":"https://byul.ai","keywords":["mcp","server","ai","news","byul","sdk"],"repository":{"type":"git","url":"git+https://github.com/byul-ai/mcp-server.git"},"description":"Byul MCP server (stdio) proxying Byul REST API","maintainers":[{"name":"lovelacedud","email":"lovelacedud@gmail.com"}],"readme":"# @byul/mcp\n\nCompliant with the latest Model Context Protocol (MCP) specification.\n\n## Links\n\n- [API Documentation](https://www.byul.ai/api)\n- [API Pricing](https://www.byul.ai/api/pricing)\n- [Developer Documentation](https://docs.byul.ai/)\n- [API Status](https://www.byul.ai/api/status)\n\n## Overview\n\n`@byul/mcp` is a stdio-based MCP server that proxies the Byul REST API. It exposes a small set of MCP tools and a resource that forward requests to Byul endpoints and return the original JSON response, plus a short article-count summary string.\n\n## Requirements\n\n- Node.js 18+\n- `BYUL_API_KEY` environment variable\n\n## Quick start\n\n```bash\nBYUL_API_KEY=byul_xxxxxxxxxxxxx npx -y @byul/mcp\n```\n\n## Configuration\n\nRegister this server as an MCP provider in your LLM client. The client will launch the server via stdio and communicate using JSON-RPC over stdin/stdout.\n\n## Parameters\n\n- Tools (summary; see `@docs` for the full spec)\n  - `news_fetch` → proxies `GET /news` with filters: `limit`, `cursor`, `sinceId`, `minImportance`, `q`, `symbol`, `startDate`, `endDate`\n- Resource (summary; see `@docs` for the full spec)\n  - `byul://news{?limit,cursor,sinceId,minImportance,q,symbol,startDate,endDate}`\n\nEach response contains:\n- A summary string like “Returned N articles”\n- The original JSON payload from the Byul API\n\n## Available Tools\n\n### `news_fetch`\n- Description: Fetch latest financial news\n- Parameters:\n  - `limit` (number, optional) – number of articles (1-100)\n  - `cursor` (string, optional) – pagination cursor from previous page\n  - `sinceId` (string, optional) – return articles created after this ID\n  - `minImportance` (number, optional) – minimum importance (1-10)\n  - `q` (string, optional) – search query\n  - `symbol` (string, optional) – stock symbol (e.g., AAPL)\n  - `startDate` (string, optional) – ISO 8601 start timestamp (UTC)\n  - `endDate` (string, optional) – ISO 8601 end timestamp (UTC)\n- Example request:\n\n```txt\nFetch top 5 news articles about AAPL from the past week\n```\n\n\n## Security\n\n- Provide the API key via the `BYUL_API_KEY` environment variable only. Do not hardcode credentials in code or configs.\n\n## Platform setup\n\n### 1) Cursor (latest)\n\n`~/.cursor/mcp.json` or project `.cursor/mcp.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"byul\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@byul/mcp\"],\n      \"env\": { \"BYUL_API_KEY\": \"byul_xxxxxxxxxxxxx\" }\n    }\n  }\n}\n```\n\n### 2) Claude Code (VS Code extension)\n\n#### CLI\n\n```bash\nclaude mcp add -e BYUL_API_KEY=byul_xxxxxxxxxxxxx --scope user byul npx -- -y @byul/mcp\n```\n\n#### Settings JSON\n\n```json\n{\n  \"mcpServers\": {\n    \"byul\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@byul/mcp\"],\n      \"env\": { \"BYUL_API_KEY\": \"byul_xxxxxxxxxxxxx\" }\n    }\n  }\n}\n```\n\n### 3) Claude Desktop\n\n#### `claude_desktop_config.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"byul\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@byul/mcp\"],\n      \"env\": { \"BYUL_API_KEY\": \"byul_xxxxxxxxxxxxx\" }\n    }\n  }\n}\n```\n\n### 4) VS Code\n\n#### Workspace `.vscode/mcp.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"byul\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@byul/mcp\"],\n      \"env\": { \"BYUL_API_KEY\": \"byul_xxxxxxxxxxxxx\" }\n    }\n  }\n}\n```\n\n### 5) Windsurf\n\n#### `windsurf_mcp.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"mcp-server-byul\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@byul/mcp\"],\n      \"env\": {\n        \"BYUL_API_KEY\": \"byul_xxxxxxxxxxxxx\"\n      }\n    }\n  }\n}\n```\n\n### 6) Gemini CLI\n\n`~/.gemini/settings.json`:\n\n```json\n{\n  \"mcpServers\": {\n    \"byul\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@byul/mcp\"],\n      \"env\": { \"BYUL_API_KEY\": \"byul_xxxxxxxxxxxxx\" }\n    }\n  }\n}\n```\n\nIf the `mcpServers` object does not exist, create it. This package supports stdio (local) transport only.\n\n## Troubleshooting\n\n- Missing API key\n  - Error example: `Missing BYUL_API_KEY environment variable`\n  - Fix: set `BYUL_API_KEY` in your environment before launching the server\n\n- Corporate proxy / firewall\n  - `npx` must reach the registry to download `@byul/mcp` on first run; configure your proxy settings accordingly\n\n- Windows / WSL path and env\n  - PowerShell example:\n    ```powershell\n    $env:BYUL_API_KEY = \"byul_xxxxxxxxxxxxx\"\n    npx -y @byul/mcp\n    ```\n\n- Transport scope\n  - This package covers only stdio transport. HTTP/SSE transports are intentionally not covered in this guide.\n\nCompliant with the latest Model Context Protocol (MCP) specification.\n\n\n","readmeFilename":"README.md"}