https://github.com/speakeasy-api/markdown-sidecar-mcp
https://github.com/speakeasy-api/markdown-sidecar-mcp
golang mcp npm pypi
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/speakeasy-api/markdown-sidecar-mcp
- Owner: speakeasy-api
- License: mit
- Created: 2025-03-20T23:03:09.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-02T01:12:27.000Z (3 months ago)
- Last Synced: 2025-04-02T01:31:03.509Z (3 months ago)
- Topics: golang, mcp, npm, pypi
- Language: TypeScript
- Homepage:
- Size: 149 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- mcp-index - Markdown Sidecar Server - Access and serve markdown documentation for NPM packages, Go Modules, and PyPi packages from a local environment, enhancing the code generation process. Default support for Python help documentation is included for packages lacking markdown documentation. (Document Processing)
README
# Markdown Sidecar MCP Server
This provides a structured way to serve and access markdown documentation from an MCP server for NPM packages, Go Modules, or PyPi packages. It enables informed code generation by exposing these markdown files as `resources` or `tools`.
> [!NOTE]
> Note: Many PyPi packages do not have markdown docs exposed, so this library will also mount python `help` root docs by default.
This is designed to be executed from within a project directory where the requested packages are already installed locally. Access always stays within your local environments working directory.
## Installation
```bash
npx -y markdown-sidecar-mcp
```
## Arguments
- `workingDir`: The working directory of your repo.
- `packageName`: The name of the package or module to request
- `registry`: Registry the package will be found in (`npm`, `gomodules`, or `pypi`)
- `docsSubDir`: [OPTIONAL] The specific subdirectory to look for markdown docs in. Defaults to package root.
- `mcpPrimitive`: [OPTIONAL] The MCP primitive to expose from the server (`tool` or `resource`). This defaults to `tool`, some clients do not currently support resources.
## Cursor Installation Steps
Add the following server definition to your `.cursor/mcp.json` file:
```json
{
"mcpServers": {
"sidecar": {
"command": "npx",
"args": [
"-y", "--package", "markdown-sidecar-mcp",
"--",
"mcp", "start",
"--workingDir", "{REPO_WORKING_DIR}",
"--packageName", "{PACKAGE_NAME}",
"--registry", "npm"
]
}
}
}
```
## Development
```bash
# Install dependencies
npm i
# Build
npm run build
# Run with Bun
npm run build:mcp
```
## Contributing
1. Fork the repository
2. Create your feature branch
3. Commit your changes and push them up
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.