agentleFS
Sign inStart free
signnowsignnow/sn-mcp-server/.github/copilot-instructions.md

sn-mcp-server

Copilot instructions8 starsChanged 7 months agoMITArchived repositoryView on GitHub

  • Installs packages
  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,349 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository8 other files it gives its agents.

The file

We split this copilot-instructions.md into the rules it gives an agent

7 rules. About 0 are common, 0 are distinctive, and 7 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Build & Install: Use pip install . or python -m build from the project root.

    line 12
  2. Very specific:

    Testing: Run pytest or python run_tests.py to execute all tests.

    line 13
  3. Very specific:

    Docker: Use docker-compose.yml and Dockerfile for containerized development and deployment.

    line 15
  4. Very specific:

    All source code is under src/ (not the project root).

    line 18
  5. Very specific:

    Use pyproject.toml for dependency and build management.

    line 22
  6. Very specific:

    Place new tests in tests/unit/ mirroring the source structure.

    line 35
  7. Very specific:

    Run all tests with pytest or python run_tests.py.

    line 36

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

Copilot Instructions for AI Coding Agents

Project Overview

  • This project is a Python-based server and client SDK for SignNow API integration, organized under src/.
  • Major components:
    • sn_mcp_server/: Main server logic, CLI, authentication, and tool integrations.
    • signnow_client/: Handles SignNow API communication, models, and utility functions.
    • examples/: Usage examples for different frameworks (LangChain, LlamaIndex, SmolAgents).
    • tests/: Unit tests, organized by module.

Key Workflows

  • Build & Install: Use pip install . or python -m build from the project root.
  • Testing: Run pytest or python run_tests.py to execute all tests. Test modules are under tests/unit/.
  • Development: Main code is in src/. Use the Makefile for common tasks if present.
  • Docker: Use docker-compose.yml and Dockerfile for containerized development and deployment.

Project Conventions

  • All source code is under src/ (not the project root).
  • Each tool in sn_mcp_server/tools/ is a self-contained integration for a specific SignNow feature.
  • Models for API payloads are in signnow_client/models/.
  • Configuration is handled via config.py in each main package.
  • Use pyproject.toml for dependency and build management.

Integration & Patterns

  • The server (sn_mcp_server/server.py) loads tools dynamically from sn_mcp_server/tools/.
  • Authentication logic is in sn_mcp_server/auth.py and sn_mcp_server/token_provider.py.
  • Client logic for SignNow API is abstracted in signnow_client/client.py and submodules.
  • Example scripts demonstrate integration patterns for external frameworks.

Examples

  • To add a new tool, create a module in sn_mcp_server/tools/ and register it in sn_mcp_server/app.py.
  • To extend API models, add to signnow_client/models/ and update relevant client methods.

Testing

  • Place new tests in tests/unit/ mirroring the source structure.
  • Run all tests with pytest or python run_tests.py.

References

  • Main entry: src/sn_mcp_server/app.py
  • Tool pattern: src/sn_mcp_server/tools/
  • Client pattern: src/signnow_client/
  • Example usage: examples/
  • Tests: tests/unit/

For more details, see README.md or source files in the referenced directories.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free