SEC EDGAR MCP

https://github.com/stefanoamorelli/sec-edgar-mcp
Admin
SEC EDGAR MCP is an open-source server that connects AI models to SEC EDGAR filings, enabling...
Tokens:3,795
Snippets:12
Trust Score:8.7
License:AGPL-3.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install sec-edgar-mcp via Pip

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/README.md

This command installs the SEC EDGAR MCP server using pip, the Python package installer. Ensure you have Python 3.11+ installed.

```bash
pip install sec-edgar-mcp
```

--------------------------------

### Install sec-edgar-mcp via Conda

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/README.md

This command installs the SEC EDGAR MCP server using Conda, a package and environment management system. This is an alternative installation method.

```bash
conda install -c stefanoamorelli sec-edgar-mcp
```

--------------------------------

### Install SEC EDGAR MCP server

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/conda/README.md

Registers the SEC EDGAR MCP server after the package has been installed. It specifies the server script, a display name, and a dependency.

```bash
mcp install sec_edgar_mcp/server.py --name "SEC EDGAR MCP" --with secedgar
```

--------------------------------

### Install conda-build

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/conda/README.md

Installs the conda-build tool, which is necessary for building conda packages locally.

```bash
conda install conda-build
```

--------------------------------

### Check Package Version (Python)

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/VERSIONING.md

This Python code snippet demonstrates how to retrieve the currently installed version of the `sec_edgar_mcp` package by importing the module and accessing its `__version__` attribute.

```Python
import sec_edgar_mcp; print(sec_edgar_mcp.__version__)
```

--------------------------------

### Create Git Tag (Bash)

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/VERSIONING.md

This snippet outlines the commands to stage changes, commit them with a version bump message, and create a Git tag for the new version. It also includes pushing the commit and tags to the remote repository.

```Bash
git add -A
git commit -m "chore: bump version to 1.0.0"
git tag v1.0.0
git push origin main --tags
```

--------------------------------

### Build conda package

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/conda/README.md

Builds the conda package from the specified directory. This command initiates the package creation process.

```bash
conda build conda/
```

--------------------------------

### Check pyproject.toml Version (Bash)

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/VERSIONING.md

This Bash command uses `grep` to find and display the line containing the version number within the `pyproject.toml` file, allowing for quick verification of the PyPI version source.

```Bash
grep "^version" pyproject.toml
```

--------------------------------

### SEC EDGAR MCP Server Configuration and Transport

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/README.md

This snippet details how to configure the SEC EDGAR MCP server for different transport protocols like stdio, streamable HTTP, or SSE. It highlights the need to adjust the `--transport` argument and potentially modify `server.py` for host configurations when integrating with platforms like Dify.

```Python
server.py --transport stdio
server.py --transport streamable-http
server.py --transport http-with-sse
```

--------------------------------

### Update Version Numbers (Bash)

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/VERSIONING.md

This snippet demonstrates how to update version numbers in the project's configuration files before a release. It shows the manual update for `pyproject.toml` and `sec_edgar_mcp/__init__.py` to ensure consistency.

```Bash
# Update pyproject.toml
version = "1.0.0"  # Remove -alpha, use proper semver

# Update sec_edgar_mcp/__init__.py
__version__ = "1.0.0"  # Must match pyproject.toml
```

--------------------------------

### Check Git Tags (Bash)

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/VERSIONING.md

This Bash command retrieves the most recent Git tag, which is crucial for verifying the latest version marker in the repository.

```Bash
git describe --tags --abbrev=0
```

--------------------------------

### Sign Git Commits with Verified Identity

Source: https://github.com/stefanoamorelli/sec-edgar-mcp/blob/main/SECURITY.md

This section details the importance of signing Git commits using verified identities, such as GPG or GitHub's web UI, to ensure authenticity, integrity, and trust in the project's code history. It explains how unsigned commits may be rejected.

```bash
git commit -S -m "Your commit message"
```

```bash
# For GitHub web UI signed commits, no specific command is needed, but ensure your account settings are configured.
```
Tokens:
Raw