Skip to content

Commit 6c4e98c

Browse files
authored
Update README.md
1 parent c06e383 commit 6c4e98c

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,61 @@
11
# buffette-code-mcp-server
2+
3+
A [MCP(Model Context Protocol)](https://www.anthropic.com/news/model-context-protocol) server that accesses to [buffet code API](https://docs.buffett-code.com/api/).
4+
5+
## Features
6+
7+
Available tools:
8+
9+
- `buffetcode_get_company` - Get company information from Buffett Code
10+
- `buffetcode_get_company_daily` - Get daily company information from Buffett Code for a specific date
11+
- `buffetcode_get_company_quarterly` - Get quarterly company information from Buffett Code for a specific year and quarter
12+
- `buffetcode_get_company_stocks` - Get company stock information from Buffett Code for a specific stock
13+
- `buffetcode_get_company_stocks_daily` Get daily company stock information from Buffett Code for a specific stock and date
14+
- `buffetcode_get_company_stocks_quarterly` - Get quarterly company stock information from Buffett Code for a specific stock and year-quarter
15+
16+
## Quick Start
17+
18+
### Installation
19+
20+
TBD
21+
22+
### Usage
23+
24+
#### Start the MCP server
25+
26+
TBD
27+
28+
#### Edit MCP configuration json for your client:
29+
30+
```json
31+
...
32+
"buffet-code": {
33+
"command": "node",
34+
"args": [
35+
"/path/to/buffet-code-mcp-server/dist/index.js"
36+
],
37+
"env": {
38+
}
39+
},
40+
...
41+
```
42+
43+
## Development
44+
45+
### Available Scripts
46+
47+
- `npm run dev` - Start the server in development mode with hot reloading
48+
- `npm run build` - Build the project for production
49+
- `npm run start` - Start the production server
50+
- `npm run lint` - Run linting checks (ESLint and Prettier)
51+
- `npm run fix` - Automatically fix linting issues
52+
- `npm run examples` - Run the example scripts
53+
54+
### Contributing
55+
56+
1. Fork the repository
57+
2. Create your feature branch
58+
3. Run tests and linting: `npm run lint`
59+
4. Commit your changes
60+
5. Push to the branch
61+
6. Create a Pull Request

0 commit comments

Comments
 (0)